# Inbox API

## Docs

- [List account links](https://docs.inboxapp.com/api-reference/account-links/list-account-links.md): List all account links for the team
- [Create campaign](https://docs.inboxapp.com/api-reference/campaigns/create-campaign.md): Create a new campaign with steps, lists, and configuration
- [Delete campaign](https://docs.inboxapp.com/api-reference/campaigns/delete-campaign.md): Permanently delete a campaign and all associated data
- [Get campaign](https://docs.inboxapp.com/api-reference/campaigns/get-campaign.md): Get full details of a specific campaign
- [List campaign targets](https://docs.inboxapp.com/api-reference/campaigns/list-campaign-targets.md): List paginated targets for a specific campaign
- [List campaigns](https://docs.inboxapp.com/api-reference/campaigns/list-campaigns.md): List campaigns with optional filtering and pagination
- [Pause campaign](https://docs.inboxapp.com/api-reference/campaigns/pause-campaign.md): Pause an active campaign
- [Start campaign](https://docs.inboxapp.com/api-reference/campaigns/start-campaign.md): Start or resume a paused campaign
- [Sync campaign](https://docs.inboxapp.com/api-reference/campaigns/sync-campaign.md): Re-sync prospect lists and rebuild the campaign plan
- [Update campaign](https://docs.inboxapp.com/api-reference/campaigns/update-campaign.md): Update any combination of campaign fields
- [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.
- [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.
- [Cancel import job](https://docs.inboxapp.com/api-reference/import-jobs/cancel-import-job.md): Cancel a running or queued import job
- [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.
- [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.
- [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.
- [Introduction](https://docs.inboxapp.com/api-reference/introduction.md): Welcome to the Inbox API documentation
- [Add leads](https://docs.inboxapp.com/api-reference/leads/add-leads.md): Add leads to a list by their platform IDs. Profiles that don't exist in the system yet will be automatically fetched and created.
- [Get lead](https://docs.inboxapp.com/api-reference/leads/get-lead.md): Get a specific lead from a list by platform ID. Returns full prospect data including CRM context and custom column values.
- [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.
- [Remove leads](https://docs.inboxapp.com/api-reference/leads/remove-leads.md): Remove leads from a list by their platform IDs
- [Update lead](https://docs.inboxapp.com/api-reference/leads/update-lead.md): Update custom column data for a lead in a list. Only list-scoped column values can be modified here. For CRM context (tags, status, notes, valuation), use the prospects API.
- [Create column](https://docs.inboxapp.com/api-reference/list-columns/create-column.md): Create a new custom column on a list
- [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
- [List columns](https://docs.inboxapp.com/api-reference/list-columns/list-columns.md): List all custom columns defined on a list
- [Update column](https://docs.inboxapp.com/api-reference/list-columns/update-column.md): Update a custom column's name or description
- [Create list](https://docs.inboxapp.com/api-reference/lists/create-list.md): Create a new list for organizing leads
- [Delete list](https://docs.inboxapp.com/api-reference/lists/delete-list.md): Permanently delete a list and remove all lead associations
- [Get list](https://docs.inboxapp.com/api-reference/lists/get-list.md): Get details of a specific list
- [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.
- [Update list](https://docs.inboxapp.com/api-reference/lists/update-list.md): Update a list's name, icon, color, or description
- [Get member](https://docs.inboxapp.com/api-reference/members/get-member.md): Get details of a specific member
- [List members](https://docs.inboxapp.com/api-reference/members/list-members.md): List all members of the team
- [Add reaction](https://docs.inboxapp.com/api-reference/messages/add-reaction.md): Add a reaction to a message. Only works for non-sandbox 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.
- [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.
- [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.
- [List messages](https://docs.inboxapp.com/api-reference/messages/list-messages.md): List messages in a thread with pagination support
- [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.
- [Remove reaction](https://docs.inboxapp.com/api-reference/messages/remove-reaction.md): Remove a reaction from a message. Only works for non-sandbox threads.
- [Send message](https://docs.inboxapp.com/api-reference/messages/send-message.md): Send a message in a thread
- [Get prospect](https://docs.inboxapp.com/api-reference/prospects/get-prospect.md): Get details of a specific prospect
- [Lookup prospect](https://docs.inboxapp.com/api-reference/prospects/lookup-prospect.md): Find an Inbox prospect by platform ID. Note that not all of Twitter is included here. A separate search API will be available for profiles not in our CRM later.
- [Update prospect context](https://docs.inboxapp.com/api-reference/prospects/update-prospect-context.md): Update context of a specific prospect
- [Create status](https://docs.inboxapp.com/api-reference/statuses/create-status.md): Create a new status to track leads through your sales pipeline
- [Delete status](https://docs.inboxapp.com/api-reference/statuses/delete-status.md): Delete a status. This will remove the status from all threads.
- [Get status](https://docs.inboxapp.com/api-reference/statuses/get-status.md): Get details of a specific status
- [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 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 statuses](https://docs.inboxapp.com/api-reference/statuses/list-statuses.md): List all statuses in the team
- [Update status](https://docs.inboxapp.com/api-reference/statuses/update-status.md): Update a status's name or color
- [Create tag](https://docs.inboxapp.com/api-reference/tags/create-tag.md): Create a new tag for organizing threads and prospects
- [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.
- [Get tag](https://docs.inboxapp.com/api-reference/tags/get-tag.md): Get details of a specific tag
- [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 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 tags](https://docs.inboxapp.com/api-reference/tags/list-tags.md): List all tags in the team
- [Update tag](https://docs.inboxapp.com/api-reference/tags/update-tag.md): Update a tag's name or color
- [Get team](https://docs.inboxapp.com/api-reference/teams/get-team.md): Get the team associated with the supplied API token.
- [Create thread](https://docs.inboxapp.com/api-reference/threads/create-thread.md): Create a new active thread with a prospect
- [Delete thread](https://docs.inboxapp.com/api-reference/threads/delete-thread.md): Soft delete a thread
- [Get thread](https://docs.inboxapp.com/api-reference/threads/get-thread.md): Get details of a specific thread
- [List threads](https://docs.inboxapp.com/api-reference/threads/list-threads.md): List threads ordered by recency with advanced filtering
- [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 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 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.
- [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.
- [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
- [Account links](https://docs.inboxapp.com/configuration/account-links.md): Managing connected X accounts in Inbox
- [Authentication](https://docs.inboxapp.com/configuration/authentication.md): Obtaining and using your Inbox API token
- [Team setup](https://docs.inboxapp.com/configuration/team-setup.md): Managing team members and roles in Inbox
- [Core concepts](https://docs.inboxapp.com/guides/core-concepts.md): Understanding the Inbox API data model
- [Managing threads](https://docs.inboxapp.com/guides/managing-threads.md): Working with conversations in the Inbox API
- [Working with messages](https://docs.inboxapp.com/guides/messages.md): Sending and retrieving messages in the Inbox API
- [Working with prospects](https://docs.inboxapp.com/guides/prospects.md): Managing prospect data and context in the Inbox API
- [Tags & statuses](https://docs.inboxapp.com/guides/tags-and-statuses.md): Organizing prospects with tags and pipeline statuses
- [Overview](https://docs.inboxapp.com/index.md): The API for sending and managing DM conversations across X, Instagram, LinkedIn, and more
- [MCP server](https://docs.inboxapp.com/mcp-server.md): Connect AI tools like Claude Desktop and Cursor to the Inbox API
- [Quick start](https://docs.inboxapp.com/quickstart.md): Send your first DM in 5 minutes
- [Error codes](https://docs.inboxapp.com/reference/error-codes.md): Understanding and handling Inbox API errors
- [Pagination](https://docs.inboxapp.com/reference/pagination.md): Handling paginated responses from the Inbox API
- [Query parameters](https://docs.inboxapp.com/reference/query-parameters.md): Encoding objects and arrays in Inbox API query parameters
- [Rate limits](https://docs.inboxapp.com/reference/rate-limits.md): Understanding and handling Inbox API rate limits
- [FAQ](https://docs.inboxapp.com/resources/faq.md): Frequently asked questions about the Inbox API
- [Supported platforms](https://docs.inboxapp.com/resources/supported-platforms.md): Current platform availability and upcoming support for Instagram, LinkedIn, and more
- [Troubleshooting](https://docs.inboxapp.com/resources/troubleshooting.md): Common issues and solutions for the Inbox API
- [campaign.completed](https://docs.inboxapp.com/webhooks/campaigns/campaign-completed.md): Occurs when a campaign is completed
- [campaign.created](https://docs.inboxapp.com/webhooks/campaigns/campaign-created.md): Occurs when a new campaign is created
- [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.started](https://docs.inboxapp.com/webhooks/campaigns/campaign-started.md): Occurs when a campaign is started
- [message.created](https://docs.inboxapp.com/webhooks/messages/message-created.md): Occurs when a message is sent or received
- [message.deleted](https://docs.inboxapp.com/webhooks/messages/message-deleted.md): Occurs when a message is deleted
- [message.edited](https://docs.inboxapp.com/webhooks/messages/message-edited.md): Occurs when a message is edited
- [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
- [Migrating from legacy webhooks](https://docs.inboxapp.com/webhooks/migrating-from-legacy.md): Update your webhook integration to the new event format
- [Webhooks overview](https://docs.inboxapp.com/webhooks/overview.md): Get notified in real time when events happen in your Inbox workspace
- [prospect.assigneeChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-assignee-changed.md): Occurs when a prospect's assignee is changed, set, or cleared
- [prospect.created](https://docs.inboxapp.com/webhooks/prospects/prospect-created.md): Occurs when a new prospect is created
- [prospect.enriched](https://docs.inboxapp.com/webhooks/prospects/prospect-enriched.md): Occurs when a prospect is enriched with additional data
- [prospect.notesChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-notes-changed.md): Occurs when a prospect's notes are updated
- [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.valuationChanged](https://docs.inboxapp.com/webhooks/prospects/prospect-valuation-changed.md): Occurs when a prospect's valuation is changed
- [status.created](https://docs.inboxapp.com/webhooks/statuses/status-created.md): Occurs when a new pipeline status is created
- [status.deleted](https://docs.inboxapp.com/webhooks/statuses/status-deleted.md): Occurs when a pipeline status is deleted
- [status.updated](https://docs.inboxapp.com/webhooks/statuses/status-updated.md): Occurs when a pipeline status is updated
- [tag.created](https://docs.inboxapp.com/webhooks/tags/tag-created.md): Occurs when a new tag is created
- [tag.deleted](https://docs.inboxapp.com/webhooks/tags/tag-deleted.md): Occurs when a tag is deleted
- [tag.updated](https://docs.inboxapp.com/webhooks/tags/tag-updated.md): Occurs when a tag is updated
- [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
- [thread.archived](https://docs.inboxapp.com/webhooks/threads/thread-archived.md): Occurs when a thread is marked as done
- [thread.assigned](https://docs.inboxapp.com/webhooks/threads/thread-assigned.md): Occurs when a thread is assigned to a team member
- [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.typing](https://docs.inboxapp.com/webhooks/threads/thread-typing.md): Occurs when a prospect is typing in an X Chat thread
- [thread.unarchived](https://docs.inboxapp.com/webhooks/threads/thread-unarchived.md): Occurs when a thread is reopened
- [thread.unassigned](https://docs.inboxapp.com/webhooks/threads/thread-unassigned.md): Occurs when a thread is unassigned from a team member
- [Verifying webhook signatures](https://docs.inboxapp.com/webhooks/verifying-signatures.md): Validate that webhook events are authentically sent by Inbox

## OpenAPI Specs

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

## Optional

- [Help center](https://helpcenter.inboxapp.com)
- [Send feedback](mailto:support@inboxapp.com)
- [Inbox on X](https://x.com/inboxapp_)