# Invent - [Welcome to Invent](https://docs.useinvent.com/introduction.md): Build powerful AI assistants and deploy them anywhere - [Your First Assistant](https://docs.useinvent.com/your-first-assistant.md): Create, train, test, and deploy your first AI assistant in minutes - [Introduction](https://docs.useinvent.com/assistants/introduction.md): Learn about AI assistants and how to create powerful customer service agents - [Capabilities](https://docs.useinvent.com/assistants/capabilities.md): What your assistant can understand and how it responds in conversations - [Channels](https://docs.useinvent.com/assistants/channels.md): Connect your assistant to WhatsApp, Instagram, Messenger, TikTok, Telegram, Slack, Gmail, SMS and your website - [WhatsApp Business](https://docs.useinvent.com/assistants/channels/whatsapp.md): Connect a WhatsApp Business phone number to your assistant and reply to chats automatically, with or without keeping your existing WhatsApp Business app - [WhatsApp Manager](https://docs.useinvent.com/assistants/channels/whatsapp-manager.md): Manage your WhatsApp Business account from inside Invent, including account health, phone numbers, business profile, and message templates, without opening Meta's Business Manager - [WhatsApp error codes](https://docs.useinvent.com/assistants/channels/whatsapp-error-codes.md): Every WhatsApp Cloud API error code explained in plain language, with what it means and how to fix it. Covers send failures, rate limits, template rejections, the 130497 country restriction, and more. - [Facebook Messenger](https://docs.useinvent.com/assistants/channels/messenger.md): Connect a Facebook Page to your assistant and reply to Messenger conversations automatically - [Instagram Direct Messages](https://docs.useinvent.com/assistants/channels/instagram.md): Connect an Instagram professional account to your assistant and reply to DMs automatically - [Telegram Bot](https://docs.useinvent.com/assistants/channels/telegram.md): Connect a Telegram bot to your assistant and reply to chats automatically - [TikTok Direct Messages](https://docs.useinvent.com/assistants/channels/tiktok.md): Connect a TikTok Business Account to your assistant and reply to DMs automatically - [Actions](https://docs.useinvent.com/assistants/actions.md): Give your assistant the power to perform real tasks, not just answer questions - [Web Widget](https://docs.useinvent.com/assistants/widget.md): Customize and embed the chat widget on your website - [Next.js](https://docs.useinvent.com/assistants/widget/install/nextjs.md): Add your Invent assistant to Next.js apps - [Remix](https://docs.useinvent.com/assistants/widget/install/remix.md): Add your Invent assistant to Remix apps - [Nuxt](https://docs.useinvent.com/assistants/widget/install/nuxt.md): Add your Invent assistant to Nuxt 3 apps - [Gatsby](https://docs.useinvent.com/assistants/widget/install/gatsby.md): Add your Invent assistant to Gatsby sites - [SvelteKit](https://docs.useinvent.com/assistants/widget/install/sveltekit.md): Add your Invent assistant to SvelteKit apps - [Astro](https://docs.useinvent.com/assistants/widget/install/astro.md): Add your Invent assistant to Astro sites - [WordPress](https://docs.useinvent.com/assistants/widget/install/wordpress.md): Add your Invent assistant to WordPress sites - [Webflow](https://docs.useinvent.com/assistants/widget/install/webflow.md): Add your Invent assistant to Webflow sites - [Contentful](https://docs.useinvent.com/assistants/widget/install/contentful.md): Add your Invent assistant to Contentful-powered sites - [Ghost](https://docs.useinvent.com/assistants/widget/install/ghost.md): Add your Invent assistant to Ghost sites - [Drupal](https://docs.useinvent.com/assistants/widget/install/drupal.md): Add your Invent assistant to Drupal sites - [Joomla](https://docs.useinvent.com/assistants/widget/install/joomla.md): Add your Invent assistant to Joomla sites - [Framer](https://docs.useinvent.com/assistants/widget/install/framer.md): Add your Invent assistant to Framer sites - [Wix](https://docs.useinvent.com/assistants/widget/install/wix.md): Add your Invent assistant to Wix sites - [Squarespace](https://docs.useinvent.com/assistants/widget/install/squarespace.md): Add your Invent assistant to Squarespace sites - [Weebly](https://docs.useinvent.com/assistants/widget/install/weebly.md): Add your Invent assistant to Weebly sites - [Shopify](https://docs.useinvent.com/assistants/widget/install/shopify.md): Add your Invent assistant to Shopify stores - [AI Routing](https://docs.useinvent.com/assistants/routing.md): Let your assistant hand conversations to the right teammate, using plain-language descriptions of who handles what - [Inbox](https://docs.useinvent.com/guides/inbox.md): View and manage every customer conversation from every channel in one unified space - [Knowledge](https://docs.useinvent.com/guides/knowledge.md): Train your AI assistant with your business data, documentation, and information - [Memory](https://docs.useinvent.com/guides/memory.md): Long-term memory that remembers every customer detail across all conversations - [Contacts](https://docs.useinvent.com/guides/audience.md): Manage your contacts, organize them into segments, and build targeted audiences for broadcasts - [Segments](https://docs.useinvent.com/guides/audience/segments.md): Group contacts into segments to target the right people with broadcasts - [Properties](https://docs.useinvent.com/guides/audience/properties.md): Define custom fields that store extra information on every contact - [Suppression List](https://docs.useinvent.com/guides/audience/suppression.md): One do-not-contact list for your workspace, covering email addresses and phone numbers - [Tracking](https://docs.useinvent.com/guides/tracking.md): Track where conversations originate from across ads, products, and web widget UTM parameters - [Auto Follow-ups](https://docs.useinvent.com/guides/auto-follow-ups.md): Let your AI assistant automatically re-engage idle conversations and follow up with customers at the right time - [Plans & Pricing](https://docs.useinvent.com/guides/pricing-and-plans.md): How much you'll pay, what's included in each plan, and how Invent's usage-based pricing works - [Broadcasts](https://docs.useinvent.com/guides/broadcasts/introduction.md): Reach your contacts on the channels they already use, in bulk or one event at a time - [Marketing Broadcasts](https://docs.useinvent.com/guides/broadcasts/marketing.md): Send one message to a group of contacts at once, immediately or scheduled for later - [Transactional Broadcasts](https://docs.useinvent.com/guides/broadcasts/transactional.md): Trigger a single message through the API the moment an event happens - [WhatsApp](https://docs.useinvent.com/guides/broadcasts/channels/whatsapp.md): Send broadcast messages at scale through approved WhatsApp Templates - [WhatsApp Best Practices](https://docs.useinvent.com/guides/broadcasts/whatsapp-best-practices.md): How to send WhatsApp broadcasts the right way, avoid Meta sanctions, and keep your number, templates, and Business Portfolio in good standing - [Overview](https://docs.useinvent.com/workspace-management/overview.md): Manage your organization's settings, members, and billing - [Members](https://docs.useinvent.com/workspace-management/members.md): Invite teammates, assign roles, and control what each person can do - [Custom Roles](https://docs.useinvent.com/workspace-management/custom-roles.md): Create roles with granular, resource-by-resource permissions for your team - [Notifications](https://docs.useinvent.com/workspace-management/notifications.md): Configure email and sound notifications for conversations assigned to you - [Connections](https://docs.useinvent.com/workspace-management/connections.md): Connect apps and services once, then reuse them everywhere in Actions, Channels, and across your workspace - [Emails](https://docs.useinvent.com/workspace-management/emails.md): Verify the addresses and domains your workspace sends email from - [API Keys](https://docs.useinvent.com/workspace-management/api-keys.md): Generate API keys to programmatically access the Invent API - [Webhooks](https://docs.useinvent.com/workspace-management/webhooks.md): Push workspace events to your own systems and watch every delivery - [Usage & Limits](https://docs.useinvent.com/workspace-management/usage-and-limits.md): See what your workspace spends its balance on, and the ceilings your plan applies - [Overview](https://docs.useinvent.com/workspace-management/sso/overview.md): Single Sign-On for your organization with domains, identity providers, and access policy - [Access Policy](https://docs.useinvent.com/workspace-management/sso/access-policy.md): Control which login methods are allowed for users on your verified domains - [Domains](https://docs.useinvent.com/workspace-management/sso/domains.md): Claim and verify email domains to control how users join your organization - [Profiles](https://docs.useinvent.com/workspace-management/sso/profiles.md): Connect your identity provider to Invent via OpenID Connect (OIDC) - [Sign-In Flow](https://docs.useinvent.com/workspace-management/sso/sign-in.md): What your team sees when signing in through SSO - [Whitelabel](https://docs.useinvent.com/workspace-management/white-label.md): Brand Invent as your own. Customize the workspace and connect your own domain for a fully white-labeled experience - [Audit Logs](https://docs.useinvent.com/workspace-management/audit-logs.md): Track and monitor all activity across your workspace - [Sub-Organizations](https://docs.useinvent.com/workspace-management/sub-organizations.md): Create independent sub-organizations, each with its own branding, domain, members, modules, and billing - [Referrals](https://docs.useinvent.com/workspace-management/referrals.md): Share your referral link and earn credits when the workspaces you refer start paying - [Build a Booking Assistant](https://docs.useinvent.com/learn-by-example.md): Build a complete yoga studio booking assistant with Google Sheets, Google Calendar, Stripe, and WhatsApp. - [Instructions vs Knowledge](https://docs.useinvent.com/guides/practical/instructions-vs-knowledge.md): Understand when to use Instructions and when to use the Knowledge Base, and why getting it wrong hurts your assistant's performance - [Writing Effective Instructions](https://docs.useinvent.com/guides/practical/writing-instructions.md): How to write clear, effective instructions that shape your assistant's behavior and deliver great customer experiences - [Context Engineering](https://docs.useinvent.com/guides/practical/context-engineering.md): Teach your assistant how to prioritize information, avoid hallucination, and deliver precise answers - [Introduction](https://docs.useinvent.com/api-reference/getting-started/introduction.md): Understand general concepts, response codes, and authentication strategies. - [Invent for Agents](https://docs.useinvent.com/api-reference/getting-started/for-agents.md): Connect to Invent and start managing assistants in a couple of calls. - [API Cookbook](https://docs.useinvent.com/api-reference/getting-started/cookbook.md): Common end-to-end tasks against the Invent API, with copy-pasteable curl. - [Pagination and Filtering](https://docs.useinvent.com/api-reference/getting-started/pagination-and-filtering.md): Learn how to paginate and filter responses from the Invent API. - [Webhooks](https://docs.useinvent.com/api-reference/getting-started/webhooks.md): Receive real-time events from Invent on your own HTTPS endpoint. - [Get Chat](https://docs.useinvent.com/api-reference/chats/get-chat.md): Get a specific chat by its ID. - [Delete Chat](https://docs.useinvent.com/api-reference/chats/delete-chat.md): Delete a specific chat by its ID. - [Update Chat](https://docs.useinvent.com/api-reference/chats/update-chat.md): Update a specific chat by its ID. - [Report Chat Typing](https://docs.useinvent.com/api-reference/chats/report-chat-typing.md): Report that a user is typing in a chat. - [Fork Chat](https://docs.useinvent.com/api-reference/chats/fork-chat.md): Fork a personal or org chat from a given message into a new chat owned by the caller. Copies the conversation up to and including the message, along with the model, tools, features and linked files. - [Cancel Chat Generation](https://docs.useinvent.com/api-reference/chats/cancel-chat-generation.md): Cancel the generation of a chat. - [Mark Chat Seen](https://docs.useinvent.com/api-reference/chats/mark-chat-seen.md): Update the member's last seen time for the chat, optionally up to one message. - [Update Chat Skills](https://docs.useinvent.com/api-reference/chats-skills/update-chat-skills.md): Replace the set of skills enabled in an org chat. - [Update Chat State](https://docs.useinvent.com/api-reference/chats-state/update-chat-state.md): Update the state of a specific chat by its ID. - [Get Chat State Info](https://docs.useinvent.com/api-reference/chats-state/get-chat-state-info.md): Get the state info of a specific chat by its ID. - [Assign Conversation](https://docs.useinvent.com/api-reference/chats-state/assign-conversation.md): Assign or unassign a conversation to/from a team member. - [Mark Chat as Unseen](https://docs.useinvent.com/api-reference/chats-unseen/mark-chat-as-unseen.md): Mark a specific chat as unseen by its ID. - [Decide Action Approvals](https://docs.useinvent.com/api-reference/chats-messages/decide-action-approvals.md): Decide several pending action approvals of a message in one request. The assistant resumes only when no pending approval remains, and exactly once. - [Decide Action Approval](https://docs.useinvent.com/api-reference/chats-messages/decide-action-approval.md): Decide on a specific action approval for a message. - [Get Chat Messages](https://docs.useinvent.com/api-reference/chats-messages/get-chat-messages.md): Get a list of messages for a specific chat. - [Create Chat Message](https://docs.useinvent.com/api-reference/chats-messages/create-chat-message.md): Create a new message for a specific chat. - [Get Chat Message](https://docs.useinvent.com/api-reference/chats-messages/get-chat-message.md): Get a specific message by its ID. - [Delete Chat Message](https://docs.useinvent.com/api-reference/chats-messages/delete-chat-message.md): Delete a specific message by its ID. - [Edit Chat Message](https://docs.useinvent.com/api-reference/chats-messages/edit-chat-message.md): Edit the text content of a specific message. - [Add Message Reaction](https://docs.useinvent.com/api-reference/chats-messages/add-message-reaction.md): React to a specific message with an emoji. - [Remove Message Reaction](https://docs.useinvent.com/api-reference/chats-messages/remove-message-reaction.md): Remove your emoji reaction from a specific message. - [Send Chat Template Message](https://docs.useinvent.com/api-reference/chats-messages/send-chat-template-message.md): Send a message through the channel's template action (e.g. a WhatsApp template). Works outside the messaging window. - [Respond to Interactive Tool](https://docs.useinvent.com/api-reference/chats-messages/respond-to-interactive-tool.md): Submit a user response to an interactive tool (e.g. connecting an app). - [Get Chat Files](https://docs.useinvent.com/api-reference/chats-files/get-chat-files.md): Retrieve all files shared in this chat. - [Get conversation summaries](https://docs.useinvent.com/api-reference/chats-memories/get-conversation-summaries.md): Retrieve all conversation summaries for a chat, created automatically every 10 messages. - [Clear conversation summaries](https://docs.useinvent.com/api-reference/chats-memories/clear-conversation-summaries.md): Delete all conversation summaries for a chat. This does not delete messages, only the summaries. - [Delete a conversation summary](https://docs.useinvent.com/api-reference/chats-memories/delete-a-conversation-summary.md): Delete a specific conversation summary by ID. - [List Connection Actions](https://docs.useinvent.com/api-reference/metadata-actions/list-connection-actions.md): Every action a connection exposes, with its input fields. Pass `lang` to localise the copy. - [Create OAuth Provider URL](https://docs.useinvent.com/api-reference/orgs-connections/create-oauth-provider-url.md): Create a URL to authenticate with an OAuth provider for a specific organization. - [Authenticate OAuth Provider](https://docs.useinvent.com/api-reference/orgs-connections/authenticate-oauth-provider.md): Authenticate with an OAuth provider to create a new connection. - [Connect OAuth Provider](https://docs.useinvent.com/api-reference/orgs-connections/connect-oauth-provider.md): Authenticate with an OAuth provider and create or re-authenticate the connection in one call. Credentials stay on the server. - [Get the options for an action](https://docs.useinvent.com/api-reference/orgs-connections/get-the-options-for-an-action.md): Returns searchable, paginated options for a connection action's fields, so you can populate dropdowns and selectors as the user configures it. - [Get the fields for an action](https://docs.useinvent.com/api-reference/orgs-connections/get-the-fields-for-an-action.md): Returns the input field schema for a connection action, so your integration can dynamically render the form used to configure that action. - [Get Org Connections](https://docs.useinvent.com/api-reference/orgs-connections/get-org-connections.md): Retrieve a list of connections for the specified app. - [Create User Connection](https://docs.useinvent.com/api-reference/orgs-connections/create-user-connection.md): Create a new connection for the specified app. - [Get a Connection](https://docs.useinvent.com/api-reference/orgs-connections/get-a-connection.md): Retrieve details of a specific connection. - [Delete a Connection](https://docs.useinvent.com/api-reference/orgs-connections/delete-a-connection.md): Delete an existing connection. - [Update a Connection](https://docs.useinvent.com/api-reference/orgs-connections/update-a-connection.md): Update the details of an existing connection. - [List WhatsApp templates](https://docs.useinvent.com/api-reference/orgs-connections/list-whatsapp-templates.md): List WhatsApp message templates (all statuses) for a connection, read through a Redis cache. - [Create a WhatsApp template](https://docs.useinvent.com/api-reference/orgs-connections/create-a-whatsapp-template.md): Create a custom WhatsApp message template and submit it to Meta for review. - [Refresh WhatsApp templates](https://docs.useinvent.com/api-reference/orgs-connections/refresh-whatsapp-templates.md): Bust the cache and refetch templates from Meta. - [Browse the WhatsApp template library](https://docs.useinvent.com/api-reference/orgs-connections/browse-the-whatsapp-template-library.md): Browse Meta's pre-approved template library (read through a Redis cache). - [Create a WhatsApp template from the library](https://docs.useinvent.com/api-reference/orgs-connections/create-a-whatsapp-template-from-the-library.md): Create a message template from an entry in Meta's pre-approved library. Submits the template to Meta for review. - [Get a WhatsApp template](https://docs.useinvent.com/api-reference/orgs-connections/get-a-whatsapp-template.md): Fetch a single WhatsApp template by id (read-through cache). - [Delete a WhatsApp template](https://docs.useinvent.com/api-reference/orgs-connections/delete-a-whatsapp-template.md): Delete a WhatsApp message template from the WABA. Meta requires `name` (and `language` for cache invalidation) in the query alongside the template id. - [Edit a WhatsApp template](https://docs.useinvent.com/api-reference/orgs-connections/edit-a-whatsapp-template.md): Edit an existing WhatsApp message template. Category and component changes may require Meta re-approval. - [List WhatsApp Flows](https://docs.useinvent.com/api-reference/orgs-connections/list-whatsapp-flows.md): List the WhatsApp Flows of a connection's WABA (read through a Redis cache). Flows are authored in Meta's Flow builder. - [List the screens of a WhatsApp Flow](https://docs.useinvent.com/api-reference/orgs-connections/list-the-screens-of-a-whatsapp-flow.md): The screens declared in the flow's JSON, for picking a flow button's entry screen (read through a Redis cache). - [List WhatsApp product catalogs](https://docs.useinvent.com/api-reference/orgs-connections/list-whatsapp-product-catalogs.md): List the product catalogs connected to a connection's WABA (read through a Redis cache). Catalogs are authored in Meta's Commerce Manager. - [Get the WhatsApp business profile](https://docs.useinvent.com/api-reference/orgs-connections/get-the-whatsapp-business-profile.md): Fetch the WhatsApp business profile of a phone number, read through a Redis cache. - [Update the WhatsApp business profile](https://docs.useinvent.com/api-reference/orgs-connections/update-the-whatsapp-business-profile.md): Update profile fields on WhatsApp; the profile picture URL is resolved to a media handle server-side. - [List WhatsApp phone numbers](https://docs.useinvent.com/api-reference/orgs-connections/list-whatsapp-phone-numbers.md): List the phone numbers on the WhatsApp Business accounts of a connection, read through a Redis cache. - [Request a WhatsApp display name change](https://docs.useinvent.com/api-reference/orgs-connections/request-a-whatsapp-display-name-change.md): Submit a new display name for WhatsApp review; the approval webhook applies it automatically. - [Deregister a WhatsApp phone number](https://docs.useinvent.com/api-reference/orgs-connections/deregister-a-whatsapp-phone-number.md): Deregister the phone number from the Cloud API; it stays on the WhatsApp Business account and can be registered again. - [Get the WhatsApp Business account overview](https://docs.useinvent.com/api-reference/orgs-connections/get-the-whatsapp-business-account-overview.md): Account info, health, messaging limit, billing state and recent account activity, read through a Redis cache. - [List WhatsApp QR codes](https://docs.useinvent.com/api-reference/orgs-connections/list-whatsapp-qr-codes.md): List the QR codes and prefilled messages of a WhatsApp phone number, read through a Redis cache. - [Create a WhatsApp QR code](https://docs.useinvent.com/api-reference/orgs-connections/create-a-whatsapp-qr-code.md): Create a QR code with a prefilled message on the WhatsApp phone number. - [Delete a WhatsApp QR code](https://docs.useinvent.com/api-reference/orgs-connections/delete-a-whatsapp-qr-code.md): Delete a QR code from the WhatsApp phone number. - [Update a WhatsApp QR code](https://docs.useinvent.com/api-reference/orgs-connections/update-a-whatsapp-qr-code.md): Update the prefilled message of a WhatsApp QR code. - [Get Org Dashboard Analytics](https://docs.useinvent.com/api-reference/orgs-analytics/get-org-dashboard-analytics.md): Get the analytics for the specified organization. - [Get Assistant Stats](https://docs.useinvent.com/api-reference/orgs-analytics/get-assistant-stats.md): Get per-assistant performance statistics for the specified organization. - [Get Team Stats](https://docs.useinvent.com/api-reference/orgs-analytics/get-team-stats.md): Get per-member performance statistics for the specified organization. - [Get Channel Distribution](https://docs.useinvent.com/api-reference/orgs-analytics/get-channel-distribution.md): Get conversation counts grouped by channel (integration_id) for the specified organization. - [Get Conversations Analytics](https://docs.useinvent.com/api-reference/orgs-analytics/get-conversations-analytics.md): Everything the Conversations analytics view renders, in one call: KPIs, the handoff flow, per-channel volume, message split, resolution and CSAT trends, and the takeover-time distribution. The channel filter applies to conversation and message volume; outcome metrics (resolution, handoffs, CSAT) are… - [Get Contact Growth](https://docs.useinvent.com/api-reference/orgs-analytics/get-contact-growth.md): Get new and unsubscribed contact counts over time with running total. - [Get Contacts by Channel](https://docs.useinvent.com/api-reference/orgs-analytics/get-contacts-by-channel.md): Get contact count per channel type. - [Get Top Segments](https://docs.useinvent.com/api-reference/orgs-analytics/get-top-segments.md): Get top segments by contact count. - [Get Org Metric Types](https://docs.useinvent.com/api-reference/orgs-analytics/get-org-metric-types.md): Get the types of metrics for the specified organization. - [Get Org Metrics](https://docs.useinvent.com/api-reference/orgs-analytics/get-org-metrics.md): Get the metrics for the specified organization. - [Get Org Metric Total](https://docs.useinvent.com/api-reference/orgs-analytics/get-org-metric-total.md): Get the total of metrics for the specified organization. - [Get Response Times](https://docs.useinvent.com/api-reference/orgs-analytics/get-response-times.md): Get average and median resolution time and human response time after transfer. - [Get Broadcast Analytics](https://docs.useinvent.com/api-reference/orgs-analytics/get-broadcast-analytics.md): Get aggregated delivery and engagement stats per broadcast. - [Get Broadcasts Overview](https://docs.useinvent.com/api-reference/orgs-analytics/get-broadcasts-overview.md): Org-wide broadcast analytics for a period: delivery funnel, volume over time, channel and failure breakdowns, and per-broadcast performance. - [Get Broadcast Detail Analytics](https://docs.useinvent.com/api-reference/orgs-analytics/get-broadcast-detail-analytics.md): Funnel, per-day engagement series, channels and failure reasons for one broadcast. - [Get Workflow Analytics](https://docs.useinvent.com/api-reference/orgs-analytics/get-workflow-analytics.md): Get aggregated run stats per workflow. - [Get Org Inbox Chats](https://docs.useinvent.com/api-reference/orgs-inbox/get-org-inbox-chats.md): Get a list of inbox chats for a specific org. - [Chat Org Inbox WebSocket](https://docs.useinvent.com/api-reference/orgs-inbox/chat-org-inbox-websocket.md): Get a WebSocket for chat events for an organization inbox. - [Get Domains](https://docs.useinvent.com/api-reference/orgs-domains/get-domains.md): Get a list of domains for a specific org. - [Create Domain](https://docs.useinvent.com/api-reference/orgs-domains/create-domain.md): Add a new domain to an org. - [Get a Domain](https://docs.useinvent.com/api-reference/orgs-domains/get-a-domain.md): Get a specific domain by its ID. - [Delete Domain](https://docs.useinvent.com/api-reference/orgs-domains/delete-domain.md): Delete a domain from an org. - [Get Domain Status](https://docs.useinvent.com/api-reference/orgs-domains/get-domain-status.md): Get the status of a domain. - [Verify Domain](https://docs.useinvent.com/api-reference/orgs-domains/verify-domain.md): Verify a domain. This will check DNS records or HTTP verification file. - [Get Domain DNS Provider](https://docs.useinvent.com/api-reference/orgs-domains/get-domain-dns-provider.md): Detect the DNS provider for a custom domain via NS lookup. - [Get Vector Index](https://docs.useinvent.com/api-reference/orgs-knowledge/get-vector-index.md): Fetch the vector index for the organization. - [Get Vector Index](https://docs.useinvent.com/api-reference/orgs-knowledge/get-vector-index-1.md): Fetch the vector index for the organization. - [Get Contents](https://docs.useinvent.com/api-reference/orgs-knowledge/get-contents.md): Fetch all contents for the organization. - [Create Content](https://docs.useinvent.com/api-reference/orgs-knowledge/create-content.md): Create a new content for the organization. - [Get Content](https://docs.useinvent.com/api-reference/orgs-knowledge/get-content.md): Fetch a specific content by ID. - [Delete Content](https://docs.useinvent.com/api-reference/orgs-knowledge/delete-content.md): Delete an existing content. - [Update Content](https://docs.useinvent.com/api-reference/orgs-knowledge/update-content.md): Update an existing content. - [Update Content URL](https://docs.useinvent.com/api-reference/orgs-knowledge/update-content-url.md): Update the URL of an existing content. - [Create Child Content](https://docs.useinvent.com/api-reference/orgs-knowledge/create-child-content.md): Create a new child content for the organization. - [Reindex Content](https://docs.useinvent.com/api-reference/orgs-knowledge/reindex-content.md): Reindex an existing content. - [Get Content Chunks](https://docs.useinvent.com/api-reference/orgs-knowledge/get-content-chunks.md): Fetch all chunks for a specific content. - [Get Content Chunk](https://docs.useinvent.com/api-reference/orgs-knowledge/get-content-chunk.md): Fetch a specific content chunk by ID. - [Get Assistants](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistants.md): Fetch all assistants for a specific org. - [Create Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/create-assistant.md): Create a new assistant for a specific org. - [Get Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistant.md): Fetch a specific assistant by ID. - [Delete Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/delete-assistant.md): Delete an existing assistant. - [Update Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/update-assistant.md): Update an existing assistant. - [Rotate Assistant Secret Key](https://docs.useinvent.com/api-reference/orgs-assistants/rotate-assistant-secret-key.md): Rotate the secret key for a specific assistant. - [Duplicate an Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/duplicate-an-assistant.md): Duplicate an assistant including its actions, agents, and knowledge links. Integrations are not cloned. When duplicating to a different org, connections, agents, and knowledge links are excluded. - [Get Assistant Integrations](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistant-integrations.md): Fetch all integrations for a specific assistant. - [Create Assistant Integration](https://docs.useinvent.com/api-reference/orgs-assistants/create-assistant-integration.md): Create a new integration for a specific assistant. - [Get Assistant Integration](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistant-integration.md): Fetch a specific assistant integration by ID. - [Delete Assistant Integration](https://docs.useinvent.com/api-reference/orgs-assistants/delete-assistant-integration.md): Delete an existing assistant integration. - [Update Assistant Integration](https://docs.useinvent.com/api-reference/orgs-assistants/update-assistant-integration.md): Update an existing assistant integration. - [Get Assistant Actions](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistant-actions.md): Fetch all actions for a specific assistant. - [Create Assistant Action](https://docs.useinvent.com/api-reference/orgs-assistants/create-assistant-action.md): Create a new action for a specific assistant. - [Get Assistant Action](https://docs.useinvent.com/api-reference/orgs-assistants/get-assistant-action.md): Fetch a specific assistant action by ID. - [Delete Assistant Action](https://docs.useinvent.com/api-reference/orgs-assistants/delete-assistant-action.md): Delete an existing assistant action. - [Update Assistant Action](https://docs.useinvent.com/api-reference/orgs-assistants/update-assistant-action.md): Update an existing assistant action. - [Bulk Assistant Actions](https://docs.useinvent.com/api-reference/orgs-assistants/bulk-assistant-actions.md): Create and delete multiple assistant actions in a single request. - [Reorder Assistant Actions](https://docs.useinvent.com/api-reference/orgs-assistants/reorder-assistant-actions.md): Reorder the actions of a specific assistant. - [Search Available Contents](https://docs.useinvent.com/api-reference/orgs-assistants/search-available-contents.md): Search for available contents that can be linked to the assistant. - [Get Contents](https://docs.useinvent.com/api-reference/orgs-assistants/get-contents.md): Fetch all contents for the organization. - [Link Knowledge Content to Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/link-knowledge-content-to-assistant.md): Link an existing knowledge content to an assistant. - [Unlink Knowledge Content from Assistant](https://docs.useinvent.com/api-reference/orgs-assistants/unlink-knowledge-content-from-assistant.md): Unlink an existing knowledge content from an assistant. - [Get Agent Actions](https://docs.useinvent.com/api-reference/orgs-agents/get-agent-actions.md): Fetch all actions for a specific agent. - [Create Agent Action](https://docs.useinvent.com/api-reference/orgs-agents/create-agent-action.md): Create a new action for a specific agent. - [Get Agent Action](https://docs.useinvent.com/api-reference/orgs-agents/get-agent-action.md): Fetch a specific agent action by ID. - [Delete Agent Action](https://docs.useinvent.com/api-reference/orgs-agents/delete-agent-action.md): Delete an existing agent action. - [Update Agent Action](https://docs.useinvent.com/api-reference/orgs-agents/update-agent-action.md): Update an existing agent action. - [Bulk Agent Actions](https://docs.useinvent.com/api-reference/orgs-agents/bulk-agent-actions.md): Create and delete multiple agent actions in a single request. - [Reorder Agent Actions](https://docs.useinvent.com/api-reference/orgs-agents/reorder-agent-actions.md): Reorder the actions of a specific agent. - [Get Skills](https://docs.useinvent.com/api-reference/orgs-skills/get-skills.md): Fetch all skills for a specific org. - [Create Skill](https://docs.useinvent.com/api-reference/orgs-skills/create-skill.md): Create a new skill for a specific org. - [Get Skill](https://docs.useinvent.com/api-reference/orgs-skills/get-skill.md): Fetch a specific skill by ID. - [Delete Skill](https://docs.useinvent.com/api-reference/orgs-skills/delete-skill.md): Delete an existing skill. - [Update Skill](https://docs.useinvent.com/api-reference/orgs-skills/update-skill.md): Update an existing skill. - [Get Org Variables](https://docs.useinvent.com/api-reference/orgs-variables/get-org-variables.md): Fetch all variables for a specific org. - [Create Org Variable](https://docs.useinvent.com/api-reference/orgs-variables/create-org-variable.md): Create a variable for a specific org. - [Update Org Variables](https://docs.useinvent.com/api-reference/orgs-variables/update-org-variables.md): Update variables for a specific org. - [Delete Org Variable](https://docs.useinvent.com/api-reference/orgs-variables/delete-org-variable.md): Delete a variable for a specific org. - [Rename Org Variable](https://docs.useinvent.com/api-reference/orgs-variables/rename-org-variable.md): Rename a variable for a specific org. - [List Webhook Events](https://docs.useinvent.com/api-reference/orgs-webhooks/list-webhook-events.md): List every event type an endpoint can subscribe to. - [List Webhooks](https://docs.useinvent.com/api-reference/orgs-webhooks/list-webhooks.md): List the webhook endpoints of an organization. - [Create Webhook](https://docs.useinvent.com/api-reference/orgs-webhooks/create-webhook.md): Create a webhook endpoint. The signing secret is returned in full here and never again — store it. - [Get Webhook](https://docs.useinvent.com/api-reference/orgs-webhooks/get-webhook.md): Retrieve a single webhook endpoint. - [Delete Webhook](https://docs.useinvent.com/api-reference/orgs-webhooks/delete-webhook.md): Delete a webhook endpoint and its delivery history. - [Update Webhook](https://docs.useinvent.com/api-reference/orgs-webhooks/update-webhook.md): Update a webhook endpoint. - [Rotate Webhook Secret](https://docs.useinvent.com/api-reference/orgs-webhooks/rotate-webhook-secret.md): Issue a new signing secret. The previous secret stops signing immediately. - [Test Webhook](https://docs.useinvent.com/api-reference/orgs-webhooks/test-webhook.md): Send a signed `ping` event to the endpoint and return the delivery result. - [List Webhook Deliveries](https://docs.useinvent.com/api-reference/orgs-webhooks/list-webhook-deliveries.md): List recent delivery attempts for an endpoint. - [Replay Webhook Delivery](https://docs.useinvent.com/api-reference/orgs-webhooks/replay-webhook-delivery.md): Re-send a past event to the endpoint as a new delivery. Works for succeeded and failed deliveries alike. - [Get Audit Logs](https://docs.useinvent.com/api-reference/orgs-audit-logs/get-audit-logs.md): Fetch all audit logs for a specific org. - [List Files](https://docs.useinvent.com/api-reference/orgs-files/list-files.md): Retrieve a list of files. - [Create File](https://docs.useinvent.com/api-reference/orgs-files/create-file.md): Create a new file. - [Get File](https://docs.useinvent.com/api-reference/orgs-files/get-file.md): Retrieve a specific file. - [Delete File](https://docs.useinvent.com/api-reference/orgs-files/delete-file.md): Delete a specific file. - [Get Consolidated Sub-Organizations Usage](https://docs.useinvent.com/api-reference/orgs-orgs/get-consolidated-sub-organizations-usage.md): Returns aggregated meter usage across all sub-organizations for the specified date range and interval. - [List Sub-Organizations](https://docs.useinvent.com/api-reference/orgs-orgs/list-sub-organizations.md): Returns all sub-organizations belonging to the specified organization. - [Create Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/create-sub-organization.md): Creates a new sub-organization belonging to the specified organization. - [Get Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/get-sub-organization.md): Returns a single sub-organization by ID belonging to the specified parent organization. - [Transfer Organization](https://docs.useinvent.com/api-reference/orgs-orgs/transfer-organization.md): Transfers an existing standalone organization to become a sub-organization of the specified parent. The requesting user must be an admin of both organizations. - [Detach Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/detach-sub-organization.md): Detaches a sub-organization from the parent, making it a standalone organization. The sub-organization retains its current features and data. - [Update Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/update-sub-organization.md): Updates a sub-organization from the parent. Accepts a partial `config` (deep-merged server-side, includes `modules` visibility toggles) and an optional `logo_id`. Feature flags are not writable from this endpoint. - [Join Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/join-sub-organization.md): Adds the authenticated parent org admin as a member of the specified sub-organization with the given role. - [Change Role in Sub-Organization](https://docs.useinvent.com/api-reference/orgs-orgs/change-role-in-sub-organization.md): Changes the role of the authenticated user in the specified sub-organization. - [Update Sub-Organization Billing Config](https://docs.useinvent.com/api-reference/orgs-orgs/update-sub-organization-billing-config.md): Updates billing configuration for a sub-organization, including spending cap. Only parent organization admins can call this endpoint. - [Get Runs](https://docs.useinvent.com/api-reference/orgs-workflows/get-runs.md): Retrieve a list of runs. - [Get Workflow Runs](https://docs.useinvent.com/api-reference/orgs-workflows/get-workflow-runs.md): Retrieve a list of runs for a specific workflow. - [Run a Workflow](https://docs.useinvent.com/api-reference/orgs-workflows/run-a-workflow.md): Run a specific workflow by its ID. - [Get a Workflow Run](https://docs.useinvent.com/api-reference/orgs-workflows/get-a-workflow-run.md): Retrieve details of a specific workflow run. - [Replay a Workflow Run](https://docs.useinvent.com/api-reference/orgs-workflows/replay-a-workflow-run.md): Replay a specific workflow run. - [Cancel a Workflow Run](https://docs.useinvent.com/api-reference/orgs-workflows/cancel-a-workflow-run.md): Cancel a workflow run that is currently running. - [Get Segments](https://docs.useinvent.com/api-reference/orgs-segments/get-segments.md): Get a list of segments for a specific org. - [Create a Segment](https://docs.useinvent.com/api-reference/orgs-segments/create-a-segment.md): Create a new segment for the organization. - [Get a Segment](https://docs.useinvent.com/api-reference/orgs-segments/get-a-segment.md): Get a specific segment by its ID. - [Delete a Segment](https://docs.useinvent.com/api-reference/orgs-segments/delete-a-segment.md): Delete a segment and all associated contact segment relationships. Contacts will not be deleted. - [Update a Segment](https://docs.useinvent.com/api-reference/orgs-segments/update-a-segment.md): Update a specific segment by its ID. - [Get Suppressions](https://docs.useinvent.com/api-reference/orgs-suppressions/get-suppressions.md): Get the org suppression list — the emails and phone numbers excluded from automated messaging. - [Suppress an Identifier](https://docs.useinvent.com/api-reference/orgs-suppressions/suppress-an-identifier.md): Add an email or phone number to the org suppression list. Suppressing an identifier that is already on the list refreshes its reason. - [Suppress Identifiers in Bulk](https://docs.useinvent.com/api-reference/orgs-suppressions/suppress-identifiers-in-bulk.md): Add many emails or phone numbers to the org suppression list at once. Contacts are never created or modified. - [Dry Run Suppress Identifiers in Bulk](https://docs.useinvent.com/api-reference/orgs-suppressions/dry-run-suppress-identifiers-in-bulk.md): Preview what a bulk suppression import would create, skip and reject. - [Remove a Suppression](https://docs.useinvent.com/api-reference/orgs-suppressions/remove-a-suppression.md): Remove an email or phone number from the org suppression list. - [Update a Suppression](https://docs.useinvent.com/api-reference/orgs-suppressions/update-a-suppression.md): Update the reason or note of a suppression entry. - [List activities](https://docs.useinvent.com/api-reference/orgs-activities/list-activities.md): Retrieve an activity timeline for the org, sorted by creation date (newest first). Filter by any combination of contact, table, record, actor, assistant, or segment. - [List duplicate contact groups](https://docs.useinvent.com/api-reference/orgs-contacts/list-duplicate-contact-groups.md): Paginated list of contacts in this org that share at least one external channel. Each group has a recommended primary and the duplicates that would be merged into it. - [List duplicates of a contact](https://docs.useinvent.com/api-reference/orgs-contacts/list-duplicates-of-a-contact.md): Returns every contact in the same org that shares at least one external channel with the contact in the URL. - [Merge contacts](https://docs.useinvent.com/api-reference/orgs-contacts/merge-contacts.md): Merge other contacts INTO the contact in the URL. If `source_contact_ids` is provided, those exact contacts are merged in; otherwise every auto-detected duplicate is merged. Source contacts are deleted. - [List contact fields](https://docs.useinvent.com/api-reference/orgs-contacts/list-contact-fields.md): List of custom contact fields - [Get Contacts](https://docs.useinvent.com/api-reference/orgs-contacts/get-contacts.md): Get a list of contacts for a specific org. - [Create a Contact](https://docs.useinvent.com/api-reference/orgs-contacts/create-a-contact.md): Create a new contact for the organization. - [Get Contact Stats](https://docs.useinvent.com/api-reference/orgs-contacts/get-contact-stats.md): Get contact subscription stats (total, subscribed, unsubscribed, blocked). - [Create Multiple Contacts](https://docs.useinvent.com/api-reference/orgs-contacts/create-multiple-contacts.md): Create multiple contacts for the organization in bulk. - [Delete Multiple Contacts](https://docs.useinvent.com/api-reference/orgs-contacts/delete-multiple-contacts.md): Delete multiple contacts and all associated channels and notes. - [Dry Run Create Multiple Contacts](https://docs.useinvent.com/api-reference/orgs-contacts/dry-run-create-multiple-contacts.md): Dry run create multiple contacts for the organization in bulk. - [Get a Contact](https://docs.useinvent.com/api-reference/orgs-contacts/get-a-contact.md): Get a specific contact by its ID. - [Delete a contact](https://docs.useinvent.com/api-reference/orgs-contacts/delete-a-contact.md): Delete a contact and all associated channels and notes. - [Update a Contact](https://docs.useinvent.com/api-reference/orgs-contacts/update-a-contact.md): Update a specific contact by its ID. - [Get Contact Last Seen](https://docs.useinvent.com/api-reference/orgs-contacts/get-contact-last-seen.md): Get the timestamp of the last message from or to this contact. - [List contact activities](https://docs.useinvent.com/api-reference/orgs-contacts/list-contact-activities.md): Retrieve the activity timeline for a contact, sorted by creation date (newest first). - [Get Contact Segments](https://docs.useinvent.com/api-reference/orgs-contacts/get-contact-segments.md): Get all segments for a specific contact. - [Add Segment to Contact](https://docs.useinvent.com/api-reference/orgs-contacts/add-segment-to-contact.md): Add a segment to a contact. - [Remove Segment from Contact](https://docs.useinvent.com/api-reference/orgs-contacts/remove-segment-from-contact.md): Remove a segment from a contact. - [Add a custom channel to a contact](https://docs.useinvent.com/api-reference/orgs-contacts/add-a-custom-channel-to-a-contact.md): Add a new custom channel to an existing contact. At least one field (name, email, phone, or username) must be provided. - [Get related entity counts for a contact channel](https://docs.useinvent.com/api-reference/orgs-contacts/get-related-entity-counts-for-a-contact-channel.md): Returns the number of chats and broadcast recipients linked to this channel. Use before deletion to warn the user about impact. - [Delete a contact channel](https://docs.useinvent.com/api-reference/orgs-contacts/delete-a-contact-channel.md): Delete a contact channel. - [Update a contact channel (only for custom channels)](https://docs.useinvent.com/api-reference/orgs-contacts/update-a-contact-channel-only-for-custom-channels.md): Update a contact channel. Only channels of type 'custom' can be updated. For other channel types, the channel information is managed by the integration and cannot be modified directly. - [Get Contact Files](https://docs.useinvent.com/api-reference/orgs-contacts/get-contact-files.md): Retrieve all files for this contact, including chat files and direct uploads. - [Upload Contact File](https://docs.useinvent.com/api-reference/orgs-contacts/upload-contact-file.md): Upload a file to a contact. - [Delete Contact File](https://docs.useinvent.com/api-reference/orgs-contacts/delete-contact-file.md): Delete a file from a contact. If the file belongs to a note with no text and is the last attachment, the note is deleted too. - [List contact comments](https://docs.useinvent.com/api-reference/orgs-contacts/list-contact-comments.md): Retrieve all comments for a contact, sorted by creation date (newest first). - [Create a contact comment](https://docs.useinvent.com/api-reference/orgs-contacts/create-a-contact-comment.md): Add a new comment to a contact. - [Get a contact comment](https://docs.useinvent.com/api-reference/orgs-contacts/get-a-contact-comment.md): Retrieve a specific comment for a contact. - [Delete a contact comment](https://docs.useinvent.com/api-reference/orgs-contacts/delete-a-contact-comment.md): Remove a comment from a contact. - [Update a contact comment](https://docs.useinvent.com/api-reference/orgs-contacts/update-a-contact-comment.md): Update the content of an existing comment. - [Get contact memories](https://docs.useinvent.com/api-reference/orgs-contacts/get-contact-memories.md): Retrieve all memories associated with a contact, sorted by importance. - [Clear all contact memories](https://docs.useinvent.com/api-reference/orgs-contacts/clear-all-contact-memories.md): Delete all memories associated with a contact. - [Delete a specific contact memory](https://docs.useinvent.com/api-reference/orgs-contacts/delete-a-specific-contact-memory.md): Delete a single memory by ID for a contact. - [Create a chat on a contact channel](https://docs.useinvent.com/api-reference/orgs-contacts/create-a-chat-on-a-contact-channel.md): Start a new chat with a contact on one of its custom channels. The chat is seeded with the contact channel as the sole member; the admin is not a chat member. Any initial message is authored as the contact. - [Send a message as a contact on a channel](https://docs.useinvent.com/api-reference/orgs-contacts/send-a-message-as-a-contact-on-a-channel.md): Post a message into an existing chat, authored as the contact (not as the admin). Only custom channels are supported. - [Decide Action Approval as a contact on a channel](https://docs.useinvent.com/api-reference/orgs-contacts/decide-action-approval-as-a-contact-on-a-channel.md): Decide on a pending action approval, recorded as the contact (not as the admin / API key). Only custom channels are supported. Use this from custom integrations so the decision is attributed to the right chat member. - [Respond to Interactive Tool as a contact on a channel](https://docs.useinvent.com/api-reference/orgs-contacts/respond-to-interactive-tool-as-a-contact-on-a-channel.md): Submit a user response to an interactive tool (e.g. an action approval), recorded as the contact (not as the admin / API key). Only custom channels are supported. Use this from custom integrations so the response is attributed to the right chat member. - [List tables](https://docs.useinvent.com/api-reference/orgs-tables/list-tables.md): List the tables defined for an org. - [Create a table](https://docs.useinvent.com/api-reference/orgs-tables/create-a-table.md): Create a new table. - [Reorder tables](https://docs.useinvent.com/api-reference/orgs-tables/reorder-tables.md): Bulk-update the display position of an org's tables in one transaction. - [Get a table](https://docs.useinvent.com/api-reference/orgs-tables/get-a-table.md): Get a single table by id. - [Delete a table](https://docs.useinvent.com/api-reference/orgs-tables/delete-a-table.md): Permanently delete a table. Irreversible: cascades all records, fields, and refs. Rejected while Record fields on other tables link to this one, unless `force` is set — those fields are then deleted with it. - [Update a table](https://docs.useinvent.com/api-reference/orgs-tables/update-a-table.md): Update a table. - [Duplicate a table](https://docs.useinvent.com/api-reference/orgs-tables/duplicate-a-table.md): Duplicate a table structure: its fields and views. Records are not copied. Not available for system tables. - [List table fields](https://docs.useinvent.com/api-reference/orgs-tables/list-table-fields.md): List the fields defined on a table, ordered by position. - [Create a table field](https://docs.useinvent.com/api-reference/orgs-tables/create-a-table-field.md): Create a new field on a table. Pass `before` / `after` (a sibling field key) to slot it at a global position; omit both to append. - [Reorder a table field](https://docs.useinvent.com/api-reference/orgs-tables/reorder-a-table-field.md): Move a field to a new global position. Pass `field_id` for the field being moved and `after` / `before` for the neighbor field key. Resequences the table and returns the updated field. - [Get a table field](https://docs.useinvent.com/api-reference/orgs-tables/get-a-table-field.md): Get a single field by id. - [Delete a table field](https://docs.useinvent.com/api-reference/orgs-tables/delete-a-table-field.md): Permanently delete a field. Cascades all values. Deleting the display field promotes the first available field, or clears it. - [Update a table field](https://docs.useinvent.com/api-reference/orgs-tables/update-a-table-field.md): Update a field. `type` and `key` can both be changed. Changing the type preserves existing values in place (they go dormant in their original column and return if the type is reverted); same-storage types reuse the value directly. System fields stay immutable. - [Export records](https://docs.useinvent.com/api-reference/orgs-tables/export-records.md): Export a table's records as a CSV file. Reflects the same `status` and `search` filters as the list endpoint. Synchronous and capped — over the limit the request is rejected with `EXPORT/OVER_SYNC_LIMIT`. - [Import records](https://docs.useinvent.com/api-reference/orgs-tables/import-records.md): Import records from a CSV or XLSX file. Headers map to field keys (override per column with `mapping`). Synchronous and capped — over the limit the request is rejected with `IMPORT/OVER_SYNC_LIMIT`. Partial success: valid rows commit, failed rows are returned per row. - [List records](https://docs.useinvent.com/api-reference/orgs-tables/list-records.md): List the records in a table. - [Create a record](https://docs.useinvent.com/api-reference/orgs-tables/create-a-record.md): Create a new record in a table. - [Bulk record operations](https://docs.useinvent.com/api-reference/orgs-tables/bulk-record-operations.md): Apply a batch of create / patch / delete operations in a single request. - [Bulk update record values](https://docs.useinvent.com/api-reference/orgs-tables/bulk-update-record-values.md): Update individual field values across many existing records in one request. Update-only: unknown records are reported in `failed`, never created. - [Duplicate a record](https://docs.useinvent.com/api-reference/orgs-tables/duplicate-a-record.md): Duplicate a record in a table. Unique-field values are not copied (left empty on the duplicate). Not available for system tables. - [List table views](https://docs.useinvent.com/api-reference/orgs-tables/list-table-views.md): List the views defined on a table, ordered by tab-strip `position`. - [Reorder this table's tab strip](https://docs.useinvent.com/api-reference/orgs-tables/reorder-this-tables-tab-strip.md): Bulk-update the position of multiple views on one table in one transaction. - [List org records](https://docs.useinvent.com/api-reference/orgs-records/list-org-records.md): List records across every custom table in the org. Primarily used to browse archived records org-wide. Pass `status=ARCHIVED` for the archive view. - [Get a record](https://docs.useinvent.com/api-reference/orgs-records/get-a-record.md): Get a single record by id. The table is resolved from the record and asserted to belong to this org. - [Delete a record](https://docs.useinvent.com/api-reference/orgs-records/delete-a-record.md): Permanently delete a record. Blocked if referenced by restrict-mode fields; cascades referenced rows on cascade-mode fields. - [Update a record](https://docs.useinvent.com/api-reference/orgs-records/update-a-record.md): Update record values and/or archived flag. - [Set a single record field value](https://docs.useinvent.com/api-reference/orgs-records/set-a-single-record-field-value.md): Upsert one field value on a record. The path accepts an encoded field id or the field key. - [List record comments](https://docs.useinvent.com/api-reference/orgs-records/list-record-comments.md): Retrieve all comments for a record, sorted by creation date (newest first). Contacts- and conversations-table records resolve to the underlying contact. - [Create a record comment](https://docs.useinvent.com/api-reference/orgs-records/create-a-record-comment.md): Add a new comment to a table record. - [Get a record comment](https://docs.useinvent.com/api-reference/orgs-records/get-a-record-comment.md): Retrieve a specific comment by id. - [Delete a record comment](https://docs.useinvent.com/api-reference/orgs-records/delete-a-record-comment.md): Remove a comment from a record. - [Update a record comment](https://docs.useinvent.com/api-reference/orgs-records/update-a-record-comment.md): Update the content or attachments of an existing comment. - [List record activities](https://docs.useinvent.com/api-reference/orgs-records/list-record-activities.md): Retrieve the activity timeline for a record, sorted by creation date (newest first). Contacts- and conversations-table records resolve to the underlying contact. - [List org views](https://docs.useinvent.com/api-reference/orgs-views/list-org-views.md): Non-archived views in the org, ordered by `position`. Pass `table_type=contacts` for the Audience tab strip, `table_type=chats` for Inbox, `table_type=custom` for user-created tables. Omit to fetch all. Per-table tab order lives under `/tables/:table_id/views`. - [Create a view](https://docs.useinvent.com/api-reference/orgs-views/create-a-view.md): Create a view on a table. `table_id` may be a regular table id or a system-table keyword (`contacts`, `chats`, `users`) — system tables are lazy-created on first interaction. - [Get a view](https://docs.useinvent.com/api-reference/orgs-views/get-a-view.md): Get a single view by id. - [Delete a view](https://docs.useinvent.com/api-reference/orgs-views/delete-a-view.md): Permanently delete a view. Blocked if this is the only view on the table. - [Update a view](https://docs.useinvent.com/api-reference/orgs-views/update-a-view.md): Update a view. `sort` is re-validated against the table's field catalog when present. - [Duplicate a view](https://docs.useinvent.com/api-reference/orgs-views/duplicate-a-view.md): Duplicate a view within the same table. The copy is appended to the tab strip and is never the default view. - [List fields available on a view](https://docs.useinvent.com/api-reference/orgs-views/list-fields-available-on-a-view.md): Every field the view's entity exposes (built-ins + dynamic TableField rows) with its `type`, `readonly`, `sortable`, and `groupable_in` capability flags. Drives the FE's axis / sort / filter / column pickers and the inline cell editor dispatch from one payload. - [List groups (columns) for a view](https://docs.useinvent.com/api-reference/orgs-views/list-groups-columns-for-a-view.md): Returns the board column descriptors (enum items, boolean buckets, date / number ranges, distinct strings) plus capability flags — `reorderable_columns` enables column-header DnD, `movable_items` enables card DnD between columns (only meaningful for enum / user / boolean axes), `axis` carries the re… - [Reorder a group (board column)](https://docs.useinvent.com/api-reference/orgs-views/reorder-a-group-board-column.md): Move a board column to a new position. Pass `group_key` for the column being moved and `after` / `before` for the neighbor group keys. The new full column order is persisted on `view.config.board.columns`. Returns the updated view. - [List records for a view](https://docs.useinvent.com/api-reference/orgs-views/list-records-for-a-view.md): Paginated records for the view, applying its sort + per-view manual positions. - [Move an item in a view](https://docs.useinvent.com/api-reference/orgs-views/move-an-item-in-a-view.md): Drag-reorder an item in any view kind. Updates the item's per-view manual position between `after` and `before`. For board views, optionally set `group_value` to drag the card between columns — the runner writes the new axis value back to the row (rejected for readonly fields and for axes that can't… - [Aggregate view records](https://docs.useinvent.com/api-reference/orgs-views/aggregate-view-records.md): Compute count/sum/avg/min/max over the records of a view, optionally grouped, windowed and filtered. Honors the view filter on top of the spec filter. - [List pages](https://docs.useinvent.com/api-reference/orgs-pages/list-pages.md): List the pages defined for an org. - [Create a page](https://docs.useinvent.com/api-reference/orgs-pages/create-a-page.md): Create a new page. The slug is auto-generated from the title when omitted. - [Reorder pages](https://docs.useinvent.com/api-reference/orgs-pages/reorder-pages.md): Bulk-update the sidebar position of multiple pages in one transaction. - [Get a page](https://docs.useinvent.com/api-reference/orgs-pages/get-a-page.md): Get a single page with its blocks, by slug or id. - [Delete a page](https://docs.useinvent.com/api-reference/orgs-pages/delete-a-page.md): Permanently delete a page and its blocks. Child pages are promoted to roots. - [Update a page](https://docs.useinvent.com/api-reference/orgs-pages/update-a-page.md): Update a page. - [Add a block](https://docs.useinvent.com/api-reference/orgs-pages/add-a-block.md): Add a block to a page. Only the type is required; data blocks can be pointed at a table or view later. - [Remove a block](https://docs.useinvent.com/api-reference/orgs-pages/remove-a-block.md): Permanently remove a block from its page. - [Update a block](https://docs.useinvent.com/api-reference/orgs-pages/update-a-block.md): Update a block config or repoint its source table or view. - [Move a block](https://docs.useinvent.com/api-reference/orgs-pages/move-a-block.md): Reposition a block between two neighbors on its page. - [Get block data](https://docs.useinvent.com/api-reference/orgs-pages/get-block-data.md): Compute a stat or chart block from its stored config, validated against the live table fields. Windows resolve to real dates at query time. - [Get Broadcasts](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcasts.md): Get a list of broadcasts for a specific org. - [Create a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/create-a-broadcast.md): Create a new broadcast for the organization. - [Get Org Broadcast Recipients](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-org-broadcast-recipients.md): Get recipients for a specific org. - [Get Broadcasts Interactions](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcasts-interactions.md): Get a list of interactions for a specific broadcast. - [Get a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-a-broadcast.md): Get a specific broadcast by its ID. - [Delete a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/delete-a-broadcast.md): Delete a broadcast. Cannot delete broadcasts that are currently sending. - [Update a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/update-a-broadcast.md): Update a specific broadcast by its ID. Only draft broadcasts can be updated. - [Send a Broadcast Test](https://docs.useinvent.com/api-reference/orgs-broadcasts/send-a-broadcast-test.md): Send a broadcast test. Can only send tests for broadcasts in DRAFT, CANCELLED or FAILED status. - [Duplicate a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/duplicate-a-broadcast.md): Duplicate a broadcast including its segments and templates. The new broadcast will be in DRAFT status. - [Get Broadcast Templates](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-templates.md): Get all templates for a specific broadcast. - [Create a Broadcast Template](https://docs.useinvent.com/api-reference/orgs-broadcasts/create-a-broadcast-template.md): Create a new template for a broadcast. The broadcast must be in DRAFT status. - [Get a Broadcast Template](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-a-broadcast-template.md): Get a specific template by its ID. - [Delete a Broadcast Template](https://docs.useinvent.com/api-reference/orgs-broadcasts/delete-a-broadcast-template.md): Delete a template. The broadcast must be in DRAFT status. Templates cannot be deleted after a broadcast starts. - [Update a Broadcast Template](https://docs.useinvent.com/api-reference/orgs-broadcasts/update-a-broadcast-template.md): Update an existing template. The broadcast must be in DRAFT status. - [Get Broadcast Field Entries](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-field-entries.md): List field entries for a broadcast. - [Update Broadcast Field Entries](https://docs.useinvent.com/api-reference/orgs-broadcasts/update-broadcast-field-entries.md): Update field entries for broadcast recipients. Replaces any existing entries for this broadcast. - [Dry Run Update Broadcast Field Entries](https://docs.useinvent.com/api-reference/orgs-broadcasts/dry-run-update-broadcast-field-entries.md): Dry run to classify entries as valid or invalid without importing anything. - [Get Broadcast Fields](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-fields.md): List all fields for a broadcast. - [Create Broadcast Field](https://docs.useinvent.com/api-reference/orgs-broadcasts/create-broadcast-field.md): Create a new field for a broadcast. - [Get Broadcast Field](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-field.md): Get a specific field for a broadcast. - [Delete Broadcast Field](https://docs.useinvent.com/api-reference/orgs-broadcasts/delete-broadcast-field.md): Delete a field and all its entries from a broadcast. - [Update Broadcast Field](https://docs.useinvent.com/api-reference/orgs-broadcasts/update-broadcast-field.md): Update a specific field for a broadcast. - [Schedule a Marketing Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/schedule-a-marketing-broadcast.md): Queue a marketing broadcast for delivery. Fires immediately when the broadcast has no scheduled_at, otherwise waits for the scheduled time. Can only be called on broadcasts in DRAFT, CANCELLED or FAILED status. - [Cancel a Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/cancel-a-broadcast.md): Cancel a broadcast, returning it to DRAFT so it can be edited and sent again. Can only cancel broadcasts in SCHEDULED or SENDING status. Cancelling a live send keeps the messages already delivered and discards the unsent remainder; a later send skips every contact that already received it. - [Get Broadcast Recipients](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-recipients.md): Get recipients for a specific broadcast. - [Get Imported Broadcast Recipients Count](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-imported-broadcast-recipients-count.md): How many contacts were imported straight into this broadcast's audience. - [Import Broadcast Recipients](https://docs.useinvent.com/api-reference/orgs-broadcasts/import-broadcast-recipients.md): Add contacts to a marketing broadcast's audience. They are resolved into recipients when the broadcast sends. - [Remove Imported Broadcast Recipients](https://docs.useinvent.com/api-reference/orgs-broadcasts/remove-imported-broadcast-recipients.md): Remove imported contacts from a broadcast's audience. Omit contact_ids to remove all of them. - [List Broadcast Audience](https://docs.useinvent.com/api-reference/orgs-broadcasts/list-broadcast-audience.md): The contacts this broadcast sends to, resolved from everyone, its segments and the contacts imported into it. - [List Imported Broadcast Contacts](https://docs.useinvent.com/api-reference/orgs-broadcasts/list-imported-broadcast-contacts.md): The contacts imported straight into this broadcast's audience. - [Retry Failed Broadcast Recipients](https://docs.useinvent.com/api-reference/orgs-broadcasts/retry-failed-broadcast-recipients.md): Put failed recipients back on the send queue. Omit recipient_ids to retry every failed recipient. - [Get Broadcast Integration Recipient Counts](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-integration-recipient-counts.md): Get integration recipient counts for a specific broadcast. - [Get Broadcast Recipient](https://docs.useinvent.com/api-reference/orgs-broadcasts/get-broadcast-recipient.md): Get a specific recipient for a broadcast. - [Delete Broadcast Recipient](https://docs.useinvent.com/api-reference/orgs-broadcasts/delete-broadcast-recipient.md): Remove a recipient that has not reached anyone yet — imported, queued, failed or skipped. - [Send a Transactional Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/send-a-transactional-broadcast.md): Fire a transactional broadcast for a single recipient. Fans out across the broadcast templates: one BroadcastRecipient row is created per template (sent or skipped). - [Activate a Transactional Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/activate-a-transactional-broadcast.md): Activate a transactional broadcast so it can accept triggers. Allowed from DRAFT or PAUSED. Requires at least one template. - [Pause a Transactional Broadcast](https://docs.useinvent.com/api-reference/orgs-broadcasts/pause-a-transactional-broadcast.md): Pause an active transactional broadcast. Triggers are rejected until the broadcast is activated again. Configuration is preserved. - [Get Email Identities](https://docs.useinvent.com/api-reference/orgs-emails/get-email-identities.md): Get a list of email identities for a specific org. - [Create an Email Identity](https://docs.useinvent.com/api-reference/orgs-emails/create-an-email-identity.md): Add a new email identity for the organization. - [Get an Email Identity](https://docs.useinvent.com/api-reference/orgs-emails/get-an-email-identity.md): Get a specific email identity by its ID. - [Delete an Email Identity](https://docs.useinvent.com/api-reference/orgs-emails/delete-an-email-identity.md): Delete an email identity and remove the identity from SES. - [Update an Email Identity](https://docs.useinvent.com/api-reference/orgs-emails/update-an-email-identity.md): Update the name or default status of an email identity. - [Verify an Email Identity](https://docs.useinvent.com/api-reference/orgs-emails/verify-an-email-identity.md): Check the current verification status of an email identity. - [Resend Verification Email](https://docs.useinvent.com/api-reference/orgs-emails/resend-verification-email.md): Resend the verification email for a pending identity. - [Get Email Domains](https://docs.useinvent.com/api-reference/orgs-emails/get-email-domains.md): Get a list of email domains for a specific org. - [Add an Email Domain](https://docs.useinvent.com/api-reference/orgs-emails/add-an-email-domain.md): Add a new email domain for DKIM verification. Returns the DKIM TXT record to add to DNS. - [Get an Email Domain](https://docs.useinvent.com/api-reference/orgs-emails/get-an-email-domain.md): Get a specific email domain by its ID. - [Delete an Email Domain](https://docs.useinvent.com/api-reference/orgs-emails/delete-an-email-domain.md): Delete an email domain and remove the identity from SES. Senders linked to this domain will be unlinked. - [Update Email Domain Settings](https://docs.useinvent.com/api-reference/orgs-emails/update-email-domain-settings.md): Update tracking configuration for an email domain. - [Verify an Email Domain](https://docs.useinvent.com/api-reference/orgs-emails/verify-an-email-domain.md): Check the current DKIM verification status of an email domain. - [Get DNS Provider](https://docs.useinvent.com/api-reference/orgs-emails/get-dns-provider.md): Detect the DNS provider for a domain via NS lookup. Returns provider info including logo, DNS settings URL, and auto-configure URL when supported. - [Get the actions for a connection](https://docs.useinvent.com/api-reference/connections-actions/get-the-actions-for-a-connection.md): Get the actions for a connection ## OpenAPI Specs - [openapi](https://api.useinvent.com/openapi.json)