# Walead.ai API Documentation

> Let's cook some outbound stuff🍳

## Docs

- [Add Lead to Campaing-Blocklist](https://docs.walead.ai/api-reference/endpoint/add-blocked-leads.md): Blocks specific contacts in a campaign using their LinkedIn public identifiers. Once blocked, these leads will not receive any messages from the campaign.
- [Add Leads to Workspace-Blocklist](https://docs.walead.ai/api-reference/endpoint/add-blocked-leads-workspace.md): Blocks specific contacts at the workspace level using their LinkedIn public identifiers. Once blocked at workspace level, these leads will not receive messages from any campaign in the workspace.
- [Add Senders to Campaign](https://docs.walead.ai/api-reference/endpoint/add-campaign-senders.md): Adds LinkedIn accounts (senders) to a campaign
- [Add Leads to Campaign](https://docs.walead.ai/api-reference/endpoint/add-leads.md): Adds new leads to an existing campaign. Supports up to 1000 leads per request.
- [Add Step to Campaign](https://docs.walead.ai/api-reference/endpoint/add-step.md): Adds a new step to the campaign sequence. Step types: invitation, message, visit_profile, screener
- [Add Variant to Step](https://docs.walead.ai/api-reference/endpoint/add-variant.md): Adds a new message variant to a step. Multiple variants enable A/B testing
- [Create Campaign](https://docs.walead.ai/api-reference/endpoint/create.md): Creates a new campaign in your workspace
- [Delete Campaign Blocked Leads](https://docs.walead.ai/api-reference/endpoint/delete-blocked-leads-campaign.md): Removes leads from the blocked list of a specific campaign, allowing them to receive campaign messages again. This endpoint unblocks previously blocked LinkedIn profiles.
- [Delete Workspace Blocked Leads](https://docs.walead.ai/api-reference/endpoint/delete-blocked-leads-workspace.md): Removes leads from the workspace-level blocked list, allowing them to receive campaign messages again. This endpoint unblocks previously blocked LinkedIn profiles across all campaigns in the workspace.
- [Delete Step from Campaign](https://docs.walead.ai/api-reference/endpoint/delete-step.md): Removes a step from the campaign sequence
- [Delete Variant](https://docs.walead.ai/api-reference/endpoint/delete-variant.md): Removes a message variant from a step
- [Get Campaigns](https://docs.walead.ai/api-reference/endpoint/get.md): Returns all campaigns from your workspace.
- [Get Campaign Blocked Leads](https://docs.walead.ai/api-reference/endpoint/get-blocked-leads-campaign.md): Retrieves the list of blocked leads for a specific campaign. This endpoint returns all LinkedIn profiles that have been blocked from receiving messages in this campaign.
- [Get Workspace Blocked Leads](https://docs.walead.ai/api-reference/endpoint/get-blocked-leads-workspace.md): Retrieves the list of blocked leads at the workspace level. This endpoint returns all LinkedIn profiles that have been blocked across all campaigns in your workspace.
- [Get Campaign Analytics](https://docs.walead.ai/api-reference/endpoint/get-campaign-analytics.md): Returns analytics for a specific campaign
- [Get Campaign by ID](https://docs.walead.ai/api-reference/endpoint/get-campaign-by-id.md): Retrieves a single campaign by its ID
- [Get Campaign Leads](https://docs.walead.ai/api-reference/endpoint/get-campaign-leads.md): Retrieves all leads associated with a specific campaign
- [Get Campaign Senders](https://docs.walead.ai/api-reference/endpoint/get-campaign-senders.md): Retrieves all LinkedIn accounts (senders) associated with a campaign
- [Get Campaign Sequence](https://docs.walead.ai/api-reference/endpoint/get-campaign-sequence.md): Returns only the sequencer: steps ordered and messages (variants) of each step
- [Get Conversation by URN](https://docs.walead.ai/api-reference/endpoint/get-conversation.md): Retrieves a single conversation with all its messages
- [Get Conversations](https://docs.walead.ai/api-reference/endpoint/get-conversations.md): Lists all conversations from your workspace inbox. Shows leads with active conversations. Supports pagination and filters.
- [Get Workspace Analytics](https://docs.walead.ai/api-reference/endpoint/get-workspace-analytics.md): Returns analytics for your workspace including campaigns, invitations, messages, and more
- [Mark Conversation as Read](https://docs.walead.ai/api-reference/endpoint/mark-conversation-read.md): Marks a conversation as read
- [Pause Campaign](https://docs.walead.ai/api-reference/endpoint/pause-campaign.md): Pauses an active campaign
- [Send Message](https://docs.walead.ai/api-reference/endpoint/send-message.md): Sends a message in a conversation
- [Start Campaign](https://docs.walead.ai/api-reference/endpoint/start-campaign.md): Starts a paused or draft campaign
- [Update Lead Status](https://docs.walead.ai/api-reference/endpoint/update-lead-status.md): Updates the status of a specific lead
- [Update Step](https://docs.walead.ai/api-reference/endpoint/update-step.md): Updates step delay and/or generic body message template
- [Update Variant](https://docs.walead.ai/api-reference/endpoint/update-variant.md): Updates a message variant's content, enabled status, or ICP definition
- [Introduction](https://docs.walead.ai/api-reference/introduction.md): Welcome to Walead.ai API documentation. Let's get start on how te set up your environment.
- [MCP (Cursor / Claude Desktop)](https://docs.walead.ai/api-reference/mcp-integration.md): Use the WaLead API as MCP tools inside Cursor, Claude Desktop, or any MCP client
- [Webhooks Overview](https://docs.walead.ai/api-reference/webhooks/introduction.md): Real-time notifications for events in your WaLead workspace
- [List Webhooks](https://docs.walead.ai/api-reference/webhooks/list.md): Retrieves a list of all webhooks subscribed in your workspace. Filter by event type or campaign ID.
- [Get Sample Webhook Data](https://docs.walead.ai/api-reference/webhooks/perform-list.md): Retrieves sample data for a specific webhook type to test your integration
- [Subscribe to Webhook](https://docs.walead.ai/api-reference/webhooks/subscribe.md): Subscribe to a webhook to receive real-time notifications for specific events
- [Unsubscribe from Webhook](https://docs.walead.ai/api-reference/webhooks/unsubscribe.md): Unsubscribe from a webhook to stop receiving notifications

## OpenAPI Specs

- [openapi](https://docs.walead.ai/api-reference/openapi.json)