# Inboxapp API

## Docs

- [Get started with Inboxapp](https://docs.inboxapp.com/index.md): Choose a path for setting up Inboxapp, sending your first outreach, or connecting the API.
- [Set up Inboxapp](https://docs.inboxapp.com/get-started/set-up.md): Connect X, confirm DM sync, and personalize your Inboxapp workspace.
- [Send your first outreach](https://docs.inboxapp.com/get-started/first-outreach.md): Create a lead list, import leads, and launch your first Inboxapp campaign.
- [Automate with the API](https://docs.inboxapp.com/get-started/automate.md): Get an API token, make your first call, and connect Inboxapp to your tools.
- [MCP server](https://docs.inboxapp.com/mcp-server.md): Connect AI tools like Claude Desktop and Cursor to the Inboxapp API
- [Help Center](https://docs.inboxapp.com/help.md): Guides and answers for Inboxapp.
- [Get started](https://docs.inboxapp.com/help/getting-started-with-inboxapp.md): Set up Inboxapp, link X, and complete your first workspace checklist.
- [Set up your Inboxapp account](https://docs.inboxapp.com/help/getting-started-with-inboxapp/setup-your-inboxapp-account.md): Sign up, install the Chrome extension, link X, and start using your workspace.
- [Personalize Inboxapp](https://docs.inboxapp.com/help/getting-started-with-inboxapp/personalize-inboxapp-to-your-needs.md): Customize statuses, tags, currency, and snippets from Settings.
- [How Inboxapp syncs your DMs](https://docs.inboxapp.com/help/getting-started-with-inboxapp/how-inboxapp-syncs-your-dms-and-what-to-expect.md): What to expect after you install the Chrome extension and link X — sync speed, Contacted/Mutual timing, and tips.
- [What is XChat and how to use it with Inboxapp](https://docs.inboxapp.com/help/getting-started-with-inboxapp/what-is-xchat-and-how-use-it-with-our-platform.md): XChat is X’s encrypted DM experience. Link your account and enter your XChat PIN so Inboxapp can sync messages.
- [Onboarding checklist](https://docs.inboxapp.com/help/getting-started-with-inboxapp/comprehensive-onboarding-setup-checklist-getting-started-with-inboxapp.md): Checklist to link X, configure settings, import leads, and verify sync before you go live.
- [Glossary](https://docs.inboxapp.com/help/getting-started-with-inboxapp/glossary.md): Short definitions for Inboxapp terms: Inboxapp plan, Pro, credits, Contacted, XChat, reachable leads, and more.
- [Account & teams](https://docs.inboxapp.com/help/account.md): Link X accounts, invite teammates, and configure pipeline statuses.
- [Add an X account to Inboxapp](https://docs.inboxapp.com/help/account/how-to-add-an-x-twitter-account-to-inboxapp.md): Install the Chrome extension, open X, and link your account with the Inboxapp floating icon.
- [Share your X inbox with a team member](https://docs.inboxapp.com/help/account/share-your-x-twitter-inbox-with-a-team-member.md): Invite a teammate to your Inboxapp team so they can access linked X inboxes.
- [Create a new team](https://docs.inboxapp.com/help/account/how-to-create-a-new-team.md): Create a separate team workspace for another brand, client, or billing group.
- [Add statuses to the pipeline](https://docs.inboxapp.com/help/account/how-to-add-statuses-to-the-pipeline.md): Create, reorder, edit, and delete CRM pipeline statuses in Settings.
- [Set up your X API integration](https://docs.inboxapp.com/help/account/setting-up-your-x-api-integration.md): Create a pay-per-use X developer app and connect it to Inboxapp for a higher daily DM allowance.
- [Leads](https://docs.inboxapp.com/help/leads-management.md): Import, organize, filter, and export leads — including reachable vs unreachable.
- [Import](https://docs.inboxapp.com/help/leads-management/importing.md): Bring leads into Inboxapp from CSV, followers, lists, and post engagement.
- [Import leads from a CSV](https://docs.inboxapp.com/help/leads-management/importing/importing-leads-to-inboxapp-from-a-csv-file.md): Upload a CSV of X usernames or user IDs into a lead list, with copyable examples.
- [Import leads from followers](https://docs.inboxapp.com/help/leads-management/importing/importing-leads-to-inboxapp-from-followers-of-an-x-twitter-account.md): Import recent followers of a public X account into a lead list.
- [Import leads from following](https://docs.inboxapp.com/help/leads-management/importing/importing-leads-to-inboxapp-from-the-following-of-an-x-twitter-account.md): Import accounts that a public X profile follows into a lead list.
- [Import leads from an X list](https://docs.inboxapp.com/help/leads-management/importing/importing-leads-from-twitter-lists-members-and-followers.md): Import members or followers of an X list into a lead list.
- [Import leads from post engagement](https://docs.inboxapp.com/help/leads-management/importing/importing-leads-from-post-engagement.md): Import profiles that liked, retweeted, replied to, or quote-tweeted a post into a lead list.
- [Troubleshooting lead imports](https://docs.inboxapp.com/help/leads-management/importing/troubleshooting-lead-imports-csv-followers-quick-guide.md): Fixes for CSV column errors, follower import limits, filtering, and slow imports.
- [Organize](https://docs.inboxapp.com/help/leads-management/organize.md): Lists, tags, filters, and exports for your leads.
- [Create your first lead list](https://docs.inboxapp.com/help/leads-management/organize/create-your-first-lead-list.md): Create a lead list, then add people from search, CSV, followers, or other import sources.
- [Tags and custom fields](https://docs.inboxapp.com/help/leads-management/organize/tags-and-custom-fields.md): Create tags and custom fields to organize leads, then filter and segment with them.
- [Filtering and segmenting leads](https://docs.inboxapp.com/help/leads-management/organize/filtering-and-segmenting-your-leads.md): Use tags, custom fields, bio search, and export filters to organize and target leads.
- [Export leads](https://docs.inboxapp.com/help/leads-management/organize/exporting-leads-from-inboxapp.md): Export filtered or selected leads to a file from the Leads page.
- [Concepts](https://docs.inboxapp.com/help/leads-management/concepts.md): System lists, Contacted, and reachable vs unreachable leads.
- [System lists](https://docs.inboxapp.com/help/leads-management/concepts/understanding-system-lists.md): Contacted and Mutual are automatic lists Inboxapp maintains from your messaging history and follows.
- [Reachable vs unreachable leads](https://docs.inboxapp.com/help/leads-management/concepts/understanding-reachable-vs-unreachable-leads.md): Why some leads can’t receive DMs, how Inboxapp filters them, and what to do when too many are removed.
- [How the Contacted list prevents duplicates](https://docs.inboxapp.com/help/leads-management/concepts/how-the-contacted-list-protects-you-from-duplicate-messaging.md): Contacted is a system list of everyone you’ve messaged; campaigns use it to avoid messaging the same person twice.
- [Campaigns](https://docs.inboxapp.com/help/campaigns.md): Create and run DM campaigns on Pro: sequences, personalization, scheduling, stages, and troubleshooting.
- [Build](https://docs.inboxapp.com/help/campaigns/build.md): Create campaigns, sequences, variables, scheduling, and A/B tests.
- [Create your first campaign](https://docs.inboxapp.com/help/campaigns/build/create-your-first-campaign.md): End-to-end: pick a lead list, write a DM, set schedule options, launch, and check stages.
- [Design multi-step DM sequences](https://docs.inboxapp.com/help/campaigns/build/how-to-design-multi-step-dm-sequences.md): Build a campaign with follow-up steps and delays between messages.
- [Personalize DMs with custom variables](https://docs.inboxapp.com/help/campaigns/build/personalizing-dms-with-custom-variables.md): Insert lead fields such as first name into campaign messages with the custom variable control.
- [Schedule campaigns across time zones](https://docs.inboxapp.com/help/campaigns/build/scheduling-campaigns-across-time-zones.md): Set send times so Inboxapp adjusts delivery for recipient time zones.
- [Run A/B tests with segmented lists](https://docs.inboxapp.com/help/campaigns/build/how-to-run-a-b-tests-in-campaigns.md): Inboxapp has no native in-campaign A/B test — split lists and run parallel campaigns instead.
- [DM outreach best practices](https://docs.inboxapp.com/help/campaigns/build/best-practices-for-dm-outreach-campaigns.md): Personalize, sequence thoughtfully, respect limits and time zones, and segment before you scale.
- [Run and measure](https://docs.inboxapp.com/help/campaigns/run-and-measure.md): Campaign stages, replies, and analytics.
- [Campaign stages](https://docs.inboxapp.com/help/campaigns/run-and-measure/understanding-campaign-stages-in-inboxapp.md): Pending, In-Sequence, Replied, Unresponsive, and Failed — how stages update automatically.
- [What happens when a lead replies](https://docs.inboxapp.com/help/campaigns/run-and-measure/what-happens-when-a-lead-replies-to-my-campaign.md): Replies stop the sequence for that lead and move them to the Replied stage automatically.
- [Campaign analytics](https://docs.inboxapp.com/help/campaigns/run-and-measure/campaign-analytics-completion-and-reply-rates.md): Find targeted count, replies, reply rate, completion rate, and duration on the Overview tab.
- [Limits and safety](https://docs.inboxapp.com/help/campaigns/limits-and-safety.md): Daily DM caps and avoiding duplicate outreach.
- [Daily DM limits](https://docs.inboxapp.com/help/campaigns/limits-and-safety/how-many-dms-can-i-send-per-day-on-x-twitter-with-inboxapp.md): How many new-contact DMs you can send per day on Pro, how BYOK changes the limit, and how to ramp up.
- [Prevent messaging leads you’ve already contacted](https://docs.inboxapp.com/help/campaigns/limits-and-safety/how-to-prevent-messaging-leads-you-ve-already-contacted.md): Exclude the Contacted system list in campaign settings so prior outreach isn’t duplicated.
- [Fix](https://docs.inboxapp.com/help/campaigns/fix.md): Campaign not sending and other common issues.
- [Campaign not sending](https://docs.inboxapp.com/help/campaigns/fix/why-is-my-campaign-not-sending-messages.md): Check excluded lists, reachable filtering, account link, schedule, and daily DM limits.
- [Campaign filtering banner](https://docs.inboxapp.com/help/campaigns/fix/what-does-we-re-currently-filtering-out-prospects-that-can-t-be-targeted-with-this-campaign-mean.md): What “We’re currently filtering out prospects that can’t be targeted with this campaign” means.
- [Common campaign issues](https://docs.inboxapp.com/help/campaigns/fix/common-campaign-issues-and-how-to-fix-them.md): Fixes for filtering, stuck campaigns, personalization, time zones, and delivery icons.
- [Outreach tips](https://docs.inboxapp.com/help/outreach.md): How to get replies on X, stay within platform rules, and choose who to message.
- [How to get replies on X](https://docs.inboxapp.com/help/outreach/how-to-get-replies-on-x.md): Earn DM replies with a credible profile, short personalized copy, and patient sequences — not volume.
- [Stay within X rules for outreach](https://docs.inboxapp.com/help/outreach/stay-within-x-rules-for-outreach.md): Keep DM outreach authentic, within platform limits, and aligned with X’s spam and automation policies.
- [Who to message and when](https://docs.inboxapp.com/help/outreach/who-to-message-and-when.md): Build tighter lists, prefer warm context, time sends for the recipient, and know when to stop.
- [Billing](https://docs.inboxapp.com/help/billing.md): Plans, credits, invoices, and subscription management.
- [Plans and credits](https://docs.inboxapp.com/help/billing/billing-plans-and-credits.md): Inboxapp and Pro pricing, what each plan includes, and how credits work on Pro.
- [How pricing works for multiple accounts](https://docs.inboxapp.com/help/billing/how-does-the-pricing-work-for-multiple-accounts.md): How Inboxapp and Pro are billed when you connect more than one X account or invite teammates.
- [Where to see your invoices](https://docs.inboxapp.com/help/billing/where-can-i-see-my-invoices.md): Open the Stripe billing portal from Settings → Billing to view and download invoices.
- [Cancel your subscription](https://docs.inboxapp.com/help/billing/how-to-cancel-my-subscription.md): Cancel from Settings → Billing via the Stripe portal, and what happens to access until period end.
- [What happens after you cancel](https://docs.inboxapp.com/help/billing/what-happens-after-you-cancel.md): Access through the end of the billing period, invoices, data, and how to resubscribe.
- [Troubleshooting](https://docs.inboxapp.com/help/troubleshooting.md): Fix sync issues, delivery icons, and common errors.
- [Chrome extension troubleshooting](https://docs.inboxapp.com/help/troubleshooting/chrome-extension-troubleshooting.md): Fix a missing Inboxapp icon, linking failures, and common extension sync problems.
- [Messages not syncing](https://docs.inboxapp.com/help/troubleshooting/messages-not-syncing-try-these-fixes.md): Check the Chrome extension, XChat PIN, sync timing, and IndexedDB when DMs don’t appear in Inboxapp.
- [Undelivered icon](https://docs.inboxapp.com/help/troubleshooting/why-do-some-of-my-messages-show-an-undelivered-icon.md): What the red undelivered icon means on older encrypted messages, and why no action is usually required.
- [Failed to send icon](https://docs.inboxapp.com/help/troubleshooting/why-do-some-of-my-messages-show-a-failed-to-send-icon.md): What the red failed-to-send icon means on encrypted messages, and when to resend or delete.
- [API](https://docs.inboxapp.com/help/api.md): Use the Inboxapp API to manage inboxes and messages programmatically.
- [Inboxapp API quickstart](https://docs.inboxapp.com/help/api/getting-started-with-the-inboxapp-api-a-complete-guide.md): Get an API key and call the Inboxapp API. The full reference lives in the API docs.
- [Overview](https://docs.inboxapp.com/developer-api.md): The API for sending and managing DM conversations across X, Instagram, LinkedIn, and more
- [Quick start](https://docs.inboxapp.com/quickstart.md): Send your first DM in 5 minutes
- [Core concepts](https://docs.inboxapp.com/guides/core-concepts.md): Understanding the Inboxapp API data model
- [Supported platforms](https://docs.inboxapp.com/resources/supported-platforms.md): Current platform availability and upcoming support for Instagram, LinkedIn, and more
- [Managing threads](https://docs.inboxapp.com/guides/managing-threads.md): Working with conversations in the Inboxapp API
- [Working with messages](https://docs.inboxapp.com/guides/messages.md): Sending and retrieving messages in the Inboxapp API
- [Working with prospects](https://docs.inboxapp.com/guides/prospects.md): Managing prospect data and context in the Inboxapp API
- [Tags & statuses](https://docs.inboxapp.com/guides/tags-and-statuses.md): Organizing prospects with tags and pipeline statuses
- [Team setup](https://docs.inboxapp.com/configuration/team-setup.md): Managing team members and roles in Inboxapp
- [Account links](https://docs.inboxapp.com/configuration/account-links.md): Managing connected X accounts in Inboxapp
- [Authentication](https://docs.inboxapp.com/configuration/authentication.md): Obtaining and using your Inboxapp API token
- [Introduction](https://docs.inboxapp.com/api-reference/introduction.md): Welcome to the Inboxapp API documentation
- [Webhooks overview](https://docs.inboxapp.com/webhooks/overview.md): Get notified in real time when events happen in your Inboxapp workspace
- [Verifying webhook signatures](https://docs.inboxapp.com/webhooks/verifying-signatures.md): Validate that webhook events are authentically sent by Inboxapp
- [Migrating from legacy webhooks](https://docs.inboxapp.com/webhooks/migrating-from-legacy.md): Update your webhook integration to the new event format
- [thread.created](https://docs.inboxapp.com/webhooks/threads/thread-created.md): Occurs when a new thread is created
- [thread.deleted](https://docs.inboxapp.com/webhooks/threads/thread-deleted.md): Occurs when a thread is deleted
- [thread.assigned](https://docs.inboxapp.com/webhooks/threads/thread-assigned.md): Occurs when a thread is assigned to a team member
- [thread.unassigned](https://docs.inboxapp.com/webhooks/threads/thread-unassigned.md): Occurs when a thread is unassigned from a team member
- [thread.archived](https://docs.inboxapp.com/webhooks/threads/thread-archived.md): Occurs when a thread is marked as done
- [thread.unarchived](https://docs.inboxapp.com/webhooks/threads/thread-unarchived.md): Occurs when a thread is reopened
- [thread.typing](https://docs.inboxapp.com/webhooks/threads/thread-typing.md): Occurs when a prospect is typing in an X Chat thread
- [message.created](https://docs.inboxapp.com/webhooks/messages/message-created.md): Occurs when a message is sent or received
- [message.edited](https://docs.inboxapp.com/webhooks/messages/message-edited.md): Occurs when a message is edited
- [message.deleted](https://docs.inboxapp.com/webhooks/messages/message-deleted.md): Occurs when a message is deleted
- [message.reactionAdded](https://docs.inboxapp.com/webhooks/messages/message-reaction-added.md): Occurs when a reaction is added to a message
- [message.reactionRemoved](https://docs.inboxapp.com/webhooks/messages/message-reaction-removed.md): Occurs when a reaction is removed from a message
- [prospect.created](https://docs.inboxapp.com/webhooks/prospects/prospect-created.md): Occurs when a new prospect is created
- [prospect.assigneeChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-assignee-changed.md): Occurs when a prospect's assignee is changed, set, or cleared
- [prospect.statusChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-status-changed.md): Occurs when a prospect's pipeline status is changed
- [prospect.tagsChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-tags-changed.md): Occurs when tags are added or removed from a prospect
- [prospect.notesChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-notes-changed.md): Occurs when a prospect's notes are updated
- [prospect.valuationChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-valuation-changed.md): Occurs when a prospect's valuation is changed
- [prospect.enriched](https://docs.inboxapp.com/webhooks/prospects/prospect-enriched.md): Occurs when a prospect is enriched with additional data
- [tag.created](https://docs.inboxapp.com/webhooks/tags/tag-created.md): Occurs when a new tag is created
- [tag.updated](https://docs.inboxapp.com/webhooks/tags/tag-updated.md): Occurs when a tag is updated
- [tag.deleted](https://docs.inboxapp.com/webhooks/tags/tag-deleted.md): Occurs when a tag is deleted
- [status.created](https://docs.inboxapp.com/webhooks/statuses/status-created.md): Occurs when a new pipeline status is created
- [status.updated](https://docs.inboxapp.com/webhooks/statuses/status-updated.md): Occurs when a pipeline status is updated
- [status.deleted](https://docs.inboxapp.com/webhooks/statuses/status-deleted.md): Occurs when a pipeline status is deleted
- [campaign.created](https://docs.inboxapp.com/webhooks/campaigns/campaign-created.md): Occurs when a new campaign is created
- [campaign.started](https://docs.inboxapp.com/webhooks/campaigns/campaign-started.md): Occurs when a campaign is started
- [campaign.paused](https://docs.inboxapp.com/webhooks/campaigns/campaign-paused.md): Occurs when a campaign is paused
- [campaign.resumed](https://docs.inboxapp.com/webhooks/campaigns/campaign-resumed.md): Occurs when a campaign is resumed
- [campaign.completed](https://docs.inboxapp.com/webhooks/campaigns/campaign-completed.md): Occurs when a campaign is completed
- [target.contacted](https://docs.inboxapp.com/webhooks/targets/target-contacted.md): Occurs when a campaign target receives the initial message
- [target.followUpSent](https://docs.inboxapp.com/webhooks/targets/target-follow-up-sent.md): Occurs when a follow-up message is sent to a campaign target
- [target.replied](https://docs.inboxapp.com/webhooks/targets/target-replied.md): Occurs when a campaign target replies
- [Error codes](https://docs.inboxapp.com/reference/error-codes.md): Understanding and handling Inboxapp API errors
- [Rate limits](https://docs.inboxapp.com/reference/rate-limits.md): Understanding and handling Inboxapp API rate limits
- [Pagination](https://docs.inboxapp.com/reference/pagination.md): Handling paginated responses from the Inboxapp API
- [Query parameters](https://docs.inboxapp.com/reference/query-parameters.md): Encoding objects and arrays in Inboxapp API query parameters
- [Troubleshooting](https://docs.inboxapp.com/resources/troubleshooting.md): Common issues and solutions for the Inboxapp API
- [FAQ](https://docs.inboxapp.com/resources/faq.md): Frequently asked questions about the Inboxapp API
- [Get team](https://docs.inboxapp.com/api-reference/teams/get-team.md): Get the team associated with the supplied API token.
- [List threads](https://docs.inboxapp.com/api-reference/threads/list-threads.md): List threads ordered by recency with advanced filtering
- [Create thread](https://docs.inboxapp.com/api-reference/threads/create-thread.md): Create a new active thread with a prospect
- [Lookup thread](https://docs.inboxapp.com/api-reference/threads/lookup-thread.md): Find a thread by account link ID and external identifier (platform ID or external ID)
- [Lookup by username](https://docs.inboxapp.com/api-reference/threads/lookup-by-username.md): Find all threads for a prospect by their exact platform username. Returns threads across all account links.
- [Lookup threads by username](https://docs.inboxapp.com/api-reference/threads/lookup-threads-by-username.md): Find all threads for a prospect by their exact platform username. Returns threads across all account links.
- [Get thread](https://docs.inboxapp.com/api-reference/threads/get-thread.md): Get details of a specific thread
- [Update thread](https://docs.inboxapp.com/api-reference/threads/update-thread.md): Mark a thread done or change assignee
- [Update thread settings](https://docs.inboxapp.com/api-reference/threads/update-thread-settings.md): Update settings for a specific thread
- [Delete thread](https://docs.inboxapp.com/api-reference/threads/delete-thread.md): Soft delete a thread
- [Send typing indicator](https://docs.inboxapp.com/api-reference/threads/send-typing-indicator.md): Sends a typing indicator to the external party in the thread. Only supported for X Chat (encrypted) threads.
- [List messages](https://docs.inboxapp.com/api-reference/messages/list-messages.md): List messages in a thread with pagination support
- [Send message](https://docs.inboxapp.com/api-reference/messages/send-message.md): Send a message in a thread
- [Quick send message](https://docs.inboxapp.com/api-reference/messages/quick-send-message.md): Send a message without knowing the thread ID ahead of time. Automatically creates a thread if needed.
- [Edit message](https://docs.inboxapp.com/api-reference/messages/edit-message.md): Edit a message in a thread. Only works for X Chat (encrypted DM) threads.
- [Delete message](https://docs.inboxapp.com/api-reference/messages/delete-message.md): Delete a message in a thread. Only works for X Chat (encrypted DM) threads.
- [Get message history](https://docs.inboxapp.com/api-reference/messages/get-message-history.md): Get the edit history and deletion status of a message. Returns all versions of the message content over time.
- [Add reaction](https://docs.inboxapp.com/api-reference/messages/add-reaction.md): Add a reaction to a message. Only works for non-sandbox threads.
- [Remove reaction](https://docs.inboxapp.com/api-reference/messages/remove-reaction.md): Remove a reaction from a message. Only works for non-sandbox threads.
- [List account links](https://docs.inboxapp.com/api-reference/account-links/list-account-links.md): List all account links for the team
- [List members](https://docs.inboxapp.com/api-reference/members/list-members.md): List all members of the team
- [Get member](https://docs.inboxapp.com/api-reference/members/get-member.md): Get details of a specific member
- [Lookup prospect](https://docs.inboxapp.com/api-reference/prospects/lookup-prospect.md): Find an Inboxapp prospect by platform ID, username, or external ID. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [Get prospect](https://docs.inboxapp.com/api-reference/prospects/get-prospect.md): Get details of a specific prospect
- [Update prospect context](https://docs.inboxapp.com/api-reference/prospects/update-prospect-context.md): Update context of a specific prospect
- [Get lists](https://docs.inboxapp.com/api-reference/lists/get-lists.md): Get lists in the team with cursor-based pagination. Optionally filter by list type.
- [Create list](https://docs.inboxapp.com/api-reference/lists/create-list.md): Create a new list for organizing leads
- [Get list](https://docs.inboxapp.com/api-reference/lists/get-list.md): Get details of a specific list
- [Update list](https://docs.inboxapp.com/api-reference/lists/update-list.md): Update a list's name, icon, color, or description
- [Delete list](https://docs.inboxapp.com/api-reference/lists/delete-list.md): Permanently delete a list and remove all lead associations
- [List columns](https://docs.inboxapp.com/api-reference/list-columns/list-columns.md): List all custom columns defined on a list
- [Create column](https://docs.inboxapp.com/api-reference/list-columns/create-column.md): Create a new custom column on a list
- [Update column](https://docs.inboxapp.com/api-reference/list-columns/update-column.md): Update a custom column's name or description
- [Delete column](https://docs.inboxapp.com/api-reference/list-columns/delete-column.md): Permanently delete a custom column and purge all lead data for this column
- [Get leads](https://docs.inboxapp.com/api-reference/leads/get-leads.md): Get leads from a list with cursor-based pagination, optional filters, and sorting. Returns full prospect data including CRM context and custom column values.
- [Add leads](https://docs.inboxapp.com/api-reference/leads/add-leads.md): Add leads to a list by platform IDs, usernames, external IDs, or a mixed leads array. Profiles not yet in the system will be fetched automatically.
- [Get lead](https://docs.inboxapp.com/api-reference/leads/get-lead.md): Get a specific lead from a list. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [Update lead](https://docs.inboxapp.com/api-reference/leads/update-lead.md): Update custom column data for a lead in a list. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [Remove leads](https://docs.inboxapp.com/api-reference/leads/remove-leads.md): Remove leads from a list by platform IDs, usernames, external IDs, or a mixed leads array.
- [Get import jobs](https://docs.inboxapp.com/api-reference/import-jobs/get-import-jobs.md): Get import jobs for a list with cursor-based pagination. Sorted by creation date, newest first.
- [Create import job](https://docs.inboxapp.com/api-reference/import-jobs/create-import-job.md): Create a new import job to add leads to a list from various sources. Poll the job status endpoint to track progress.
- [Get import job](https://docs.inboxapp.com/api-reference/import-jobs/get-import-job.md): Get the current status and progress of an import job. Poll this endpoint to track completion.
- [Cancel import job](https://docs.inboxapp.com/api-reference/import-jobs/cancel-import-job.md): Cancel a running or queued import job
- [Pause import job](https://docs.inboxapp.com/api-reference/import-jobs/pause-import-job.md): Pause a running import job. It can be resumed later.
- [Resume import job](https://docs.inboxapp.com/api-reference/import-jobs/resume-import-job.md): Resume a paused import job. If all import slots are occupied, the job will be queued until a slot becomes available.
- [Bulk cancel import jobs](https://docs.inboxapp.com/api-reference/import-jobs/bulk-cancel-import-jobs.md): Cancel import jobs. When jobIds is omitted, cancels all non-terminated jobs on the list. Frees up slots for queued jobs.
- [Bulk pause import jobs](https://docs.inboxapp.com/api-reference/import-jobs/bulk-pause-import-jobs.md): Pause import jobs. When jobIds is omitted, pauses all running and queued jobs on the list. Also freezes the import queue.
- [Bulk resume import jobs](https://docs.inboxapp.com/api-reference/import-jobs/bulk-resume-import-jobs.md): Resume paused import jobs. When jobIds is omitted, resumes all paused jobs. Jobs are started immediately if slots are available, otherwise queued. Also unfreezes the import queue.
- [List campaigns](https://docs.inboxapp.com/api-reference/campaigns/list-campaigns.md): List campaigns with optional status filtering and cursor-based pagination
- [Create campaign](https://docs.inboxapp.com/api-reference/campaigns/create-campaign.md): Create a new campaign. Optionally pass rules to configure lead sources and exclusions at creation time, or update them later via [Update lead rules](#tag/campaigns/PATCH/campaigns/{campaignId}/rules).
- [Get campaign](https://docs.inboxapp.com/api-reference/campaigns/get-campaign.md): Retrieve full details of a specific campaign including its rules, sequence, and automations
- [Delete campaign](https://docs.inboxapp.com/api-reference/campaigns/delete-campaign.md): Permanently delete a campaign and all associated data including leads, sequences, and automations
- [Update campaign](https://docs.inboxapp.com/api-reference/campaigns/update-campaign.md): Update any combination of campaign fields. Only provided fields are changed; omitted fields remain unchanged.
- [Enable campaign](https://docs.inboxapp.com/api-reference/campaigns/enable-campaign.md): Enable message dispatch for a campaign. If the campaign is in draft status, this transitions it to active. If paused, this resumes sending according to the configured schedule. The campaign must have at least one lead, one linked account, and a valid sequence. See [Update sequence](#tag/campaigns/PU…
- [Disable campaign](https://docs.inboxapp.com/api-reference/campaigns/disable-campaign.md): Disable message dispatch for a campaign. This transitions the campaign to paused status. Messages in flight may still be delivered. To re-enable, use [Enable campaign](#tag/campaigns/POST/campaigns/{campaignId}/enable).
- [Update lead rules](https://docs.inboxapp.com/api-reference/campaigns/update-lead-rules.md): Update the lead rules for a campaign. Lead rules determine which leads are automatically included or excluded.
- [Update sequence](https://docs.inboxapp.com/api-reference/campaigns/update-sequence.md): Replace the entire sequence with a new set of steps. Creates a new version; previous versions are preserved for historical reference. The server assigns step IDs and ranks from array order. Message steps can use variables — see [Create column](#tag/campaigns/POST/campaigns/{campaignId}/columns) to s…
- [List leads](https://docs.inboxapp.com/api-reference/campaigns/list-leads.md): List campaign leads with cursor-based pagination, optional filters, search, and sorting. Returns full prospect data including CRM context, custom column values, and campaign stage.
- [Add leads](https://docs.inboxapp.com/api-reference/campaigns/add-leads.md): Add leads to a campaign by platform IDs, usernames, external IDs, or a mixed leads array. Profiles not yet in the system will be fetched automatically.
- [Remove leads](https://docs.inboxapp.com/api-reference/campaigns/remove-leads.md): Remove leads from a campaign by platform IDs, usernames, external IDs, or a mixed leads array.
- [Get lead](https://docs.inboxapp.com/api-reference/campaigns/get-lead.md): Get a specific lead from a campaign. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [Update lead](https://docs.inboxapp.com/api-reference/campaigns/update-lead.md): Update custom column data for a lead in the campaign. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [Cancel lead](https://docs.inboxapp.com/api-reference/campaigns/cancel-lead.md): Cancel a lead's campaign sequence, preventing further messages from being sent. The lead transitions to the 'canceled' stage. By default the identifier is treated as a platform ID. Use the `by` query parameter to look up by username or external ID instead.
- [List columns](https://docs.inboxapp.com/api-reference/campaigns/list-columns.md): List all custom columns defined on a campaign. Columns store per-lead data like company name or role, and can be used as variables in message templates.
- [Create column](https://docs.inboxapp.com/api-reference/campaigns/create-column.md): Create a new custom column on a campaign. Columns can be used as variables in message templates and to store per-lead data.
- [Delete column](https://docs.inboxapp.com/api-reference/campaigns/delete-column.md): Permanently delete a custom column and purge all lead data for this column. This action cannot be undone.
- [Update column](https://docs.inboxapp.com/api-reference/campaigns/update-column.md): Update a custom column's name or description.
- [List import jobs](https://docs.inboxapp.com/api-reference/campaigns/list-import-jobs.md): List import jobs for a campaign with cursor-based pagination. Sorted by creation date, newest first.
- [Create import job](https://docs.inboxapp.com/api-reference/campaigns/create-import-job.md): Create a new import job to add leads to the campaign from various sources. The job runs asynchronously in the background — poll the job status endpoint to track progress.
- [Get import job](https://docs.inboxapp.com/api-reference/campaigns/get-import-job.md): Get the current status and progress of an import job. Poll this endpoint to track completion.
- [Cancel import job](https://docs.inboxapp.com/api-reference/campaigns/cancel-import-job.md): Cancel a running or queued import job.
- [Pause import job](https://docs.inboxapp.com/api-reference/campaigns/pause-import-job.md): Pause a running import job. It can be resumed later.
- [Resume import job](https://docs.inboxapp.com/api-reference/campaigns/resume-import-job.md): Resume a paused import job. If all import slots are occupied, the job will be queued until a slot becomes available.
- [Set automations](https://docs.inboxapp.com/api-reference/campaigns/set-automations.md): Set the full list of automations for a campaign. Replaces all existing automations. Automations trigger actions when certain events occur (e.g., setting a status or applying tags when a prospect replies).
- [List tags](https://docs.inboxapp.com/api-reference/tags/list-tags.md): List all tags in the team
- [Create tag](https://docs.inboxapp.com/api-reference/tags/create-tag.md): Create a new tag for organizing threads and prospects
- [Get tag](https://docs.inboxapp.com/api-reference/tags/get-tag.md): Get details of a specific tag
- [Update tag](https://docs.inboxapp.com/api-reference/tags/update-tag.md): Update a tag's name or color
- [Delete tag](https://docs.inboxapp.com/api-reference/tags/delete-tag.md): Delete a tag. This will remove the tag from all threads and prospects.
- [List tag colors](https://docs.inboxapp.com/api-reference/tags/list-tag-colors.md): Get a list of predefined colors that can be used when creating or updating tags
- [List available colors](https://docs.inboxapp.com/api-reference/tags/list-available-colors.md): Get a list of predefined colors that can be used when creating or updating tags
- [List statuses](https://docs.inboxapp.com/api-reference/statuses/list-statuses.md): List all statuses in the team
- [Create status](https://docs.inboxapp.com/api-reference/statuses/create-status.md): Create a new status to track leads through your sales pipeline
- [Get status](https://docs.inboxapp.com/api-reference/statuses/get-status.md): Get details of a specific status
- [Update status](https://docs.inboxapp.com/api-reference/statuses/update-status.md): Update a status's name or color
- [Delete status](https://docs.inboxapp.com/api-reference/statuses/delete-status.md): Delete a status. This will remove the status from all threads.
- [List status colors](https://docs.inboxapp.com/api-reference/statuses/list-status-colors.md): Get a list of predefined colors that can be used when creating or updating statuses
- [List available colors](https://docs.inboxapp.com/api-reference/statuses/list-available-colors.md): Get a list of predefined colors that can be used when creating or updating statuses
- [List colors](https://docs.inboxapp.com/api-reference/colors/list-colors.md): Get a list of predefined colors that can be used when creating or updating tags or statuses
- [List events](https://docs.inboxapp.com/api-reference/events/list-events.md): List webhook events for replay. Events are stored for 7 days.

## OpenAPI Specs

- [inbox-api](https://docs.inboxapp.com/inbox-api.json)
- [openapi](https://docs.inboxapp.com/api-reference/openapi.json)