# Rocketlead

## API Docs
- Accounts [List WA accounts](https://docs.rocketlead.com/list-wa-accounts-30075969e0.md): List all WhatsApp accounts in the workspace. Supports filtering by phase, connection status, and search. Returns paginated results sorted by the specified field.
- Accounts [Get account by ID](https://docs.rocketlead.com/get-account-by-id-30075970e0.md): Get full details of a specific WhatsApp account including phone number, display name, connection status, phase, and message stats.
- Accounts [Get account activity](https://docs.rocketlead.com/get-account-activity-30075971e0.md): Get daily message activity stats for a WhatsApp account over the specified number of days. Returns sent and received message counts per day.
- Accounts [Register phone on WhatsApp](https://docs.rocketlead.com/register-phone-on-whatsapp-30075972e0.md): Register a new phone number on WhatsApp. Initiates the WhatsApp registration process for the given phone number with optional display name and bio.
- Accounts [Connect WA account](https://docs.rocketlead.com/connect-wa-account-30075973e0.md): Connect a previously registered WhatsApp account so it can send and receive messages.
- Accounts [Setup account profile](https://docs.rocketlead.com/setup-account-profile-30075974e0.md): Set up the WhatsApp profile for an account including display name and bio.
- Accounts [Toggle account pause state](https://docs.rocketlead.com/toggle-account-pause-state-30075975e0.md): Pause or resume a WhatsApp account. Paused accounts will not send or receive campaign messages.
- Accounts [Update account phase](https://docs.rocketlead.com/update-account-phase-30075976e0.md): Update the current phase of a WhatsApp account (e.g. warmup, ready, suspended). Optionally provide a reason.
- Accounts [Set account display name](https://docs.rocketlead.com/set-account-display-name-30075977e0.md): Set or update the WhatsApp display name for an account.
- Accounts [Set account avatar](https://docs.rocketlead.com/set-account-avatar-30075978e0.md): Set or update the WhatsApp profile picture. Provide either a URL or a base64-encoded image file.
- Campaigns [List campaigns](https://docs.rocketlead.com/list-campaigns-30075979e0.md): List all WhatsApp campaigns with optional filters for status, search, date range, reply rate, and bounce rate. Returns paginated results sorted by the specified field.
- Campaigns [Create campaign](https://docs.rocketlead.com/create-campaign-30075980e0.md): Create a new WhatsApp campaign. Optionally assign WhatsApp accounts and lead lists, configure schedule (timezone, working hours, working days, delay between messages), and set stop-on-reply behavior.
- Campaigns [Get campaign by ID](https://docs.rocketlead.com/get-campaign-by-id-30075981e0.md): Get full details of a specific campaign including name, status, steps, schedule config, assigned accounts, lead lists, and aggregate stats.
- Campaigns [Update campaign](https://docs.rocketlead.com/update-campaign-30075982e0.md): Update campaign settings including name, description, schedule config, stop-on-reply, first-message buttons, scheduled start time, and variant optimization settings.
- Campaigns [Delete campaign](https://docs.rocketlead.com/delete-campaign-30075983e0.md): Permanently delete a campaign and all its steps, leads, and stats. Cannot be undone.
- Campaigns [Add step to campaign](https://docs.rocketlead.com/add-step-to-campaign-30075984e0.md): Add a new step to a campaign sequence. Step types include message, delay, condition, wait_for_reply, add_tag, remove_tag, webhook, and goto. Message steps support templates with variables, media attachments, and buttons.
- Campaigns [Update campaign step](https://docs.rocketlead.com/update-campaign-step-30075985e0.md): Update an existing campaign step. Can change step type, message template, media, delay, conditions, branches, tags, webhooks, variants (for A/B testing), and buttons.
- Campaigns [Delete campaign step](https://docs.rocketlead.com/delete-campaign-step-30075986e0.md): Delete a step from a campaign sequence. Cannot be undone.
- Campaigns [Reorder campaign steps](https://docs.rocketlead.com/reorder-campaign-steps-30075987e0.md): Reorder the steps of a campaign sequence by providing the step IDs in the desired order.
- Campaigns [Upload campaign media](https://docs.rocketlead.com/upload-campaign-media-30075988e0.md): Upload a media file (image, video, audio, document) for use in campaign message steps. Provide the file as a base64-encoded string with its MIME type.
- Campaigns [Send test message for a campaign step](https://docs.rocketlead.com/send-test-message-for-a-campaign-step-30075989e0.md): Send a test message for a specific campaign step to a recipient phone number using a specified WhatsApp account. Useful for previewing messages before launching a campaign.
- Campaigns [Start campaign](https://docs.rocketlead.com/start-campaign-30075990e0.md): Start a campaign to begin sending messages to leads according to the configured schedule and steps.
- Campaigns [Pause campaign](https://docs.rocketlead.com/pause-campaign-30075991e0.md): Pause a running campaign. No new messages will be sent until the campaign is resumed or started again.
- Campaigns [Add leads to campaign](https://docs.rocketlead.com/add-leads-to-campaign-30075992e0.md): Add leads to a campaign by providing individual lead IDs or a lead list ID. Up to 10,000 leads can be added at once.
- Campaigns [List campaign leads](https://docs.rocketlead.com/list-campaign-leads-30075993e0.md): List leads assigned to a campaign with their status (pending, active, paused, completed, failed). Supports filtering by status and pagination.
- Campaigns [Bulk lead action](https://docs.rocketlead.com/bulk-lead-action-30075994e0.md): Perform a bulk action on campaign leads: pause, resume, or remove them from the campaign.
- Campaigns [Import leads into campaign](https://docs.rocketlead.com/import-leads-into-campaign-30075995e0.md): Import new leads directly into a campaign with their contact details. Each lead requires at minimum a phone number. Up to 10,000 leads per request.
- Campaigns [Get campaign daily stats](https://docs.rocketlead.com/get-campaign-daily-stats-30075996e0.md): Get daily message statistics for a campaign over the specified number of days. Returns sent, read, replied, and failed counts per day.
- Campaigns [Duplicate campaign](https://docs.rocketlead.com/duplicate-campaign-30075997e0.md): Create a copy of a campaign. Optionally copy leads, accounts, sequence steps, and settings. The duplicate will be created in draft status.
- Campaigns [Archive campaign](https://docs.rocketlead.com/archive-campaign-30075998e0.md): Archive a campaign. Archived campaigns are hidden from the default list view but can still be accessed.
- Leads [List all leads](https://docs.rocketlead.com/list-all-leads-30075999e0.md): List all leads across all lead lists. Supports search by name/phone, filtering by list, WhatsApp validation status, and tags. Returns paginated results.
- Leads [List all lead tags](https://docs.rocketlead.com/list-all-lead-tags-30076000e0.md): Get all unique tags used across all leads in the workspace.
- Leads [Update a lead](https://docs.rocketlead.com/update-a-lead-30076001e0.md): Update lead details including phone, name, company, email, tags, notes, and custom fields.
- Leads [Bulk delete leads](https://docs.rocketlead.com/bulk-delete-leads-30076002e0.md): Permanently delete multiple leads by their IDs. Cannot be undone. Maximum 10,000 leads per request.
- Leads [List custom field definitions](https://docs.rocketlead.com/list-custom-field-definitions-30076003e0.md): List all custom field definitions for leads in the workspace.
- Leads [Create custom field definition](https://docs.rocketlead.com/create-custom-field-definition-30076004e0.md): Create a new custom field definition. Supported types: text, number, date, select, boolean.
- Lead Lists [List lead lists](https://docs.rocketlead.com/list-lead-lists-30076005e0.md): List all lead lists in the workspace with lead counts and metadata. Optionally filter by search query.
- Lead Lists [Create lead list](https://docs.rocketlead.com/create-lead-list-30076006e0.md): Create a new empty lead list. Leads can be added individually or via bulk import.
- Lead Lists [Get lead list by ID](https://docs.rocketlead.com/get-lead-list-by-id-30076007e0.md): Get details of a specific lead list including name, source, and lead count.
- Lead Lists [Delete lead list](https://docs.rocketlead.com/delete-lead-list-30076008e0.md): Delete a lead list and all its leads. Cannot be undone.
- Lead Lists [List leads in a list](https://docs.rocketlead.com/list-leads-in-a-list-30076009e0.md): List all leads belonging to a specific lead list. Supports search filtering.
- Lead Lists [Add lead to list](https://docs.rocketlead.com/add-lead-to-list-30076010e0.md): Add a single lead to a lead list with phone number and optional contact details.
- Lead Lists [Bulk import leads to list](https://docs.rocketlead.com/bulk-import-leads-to-list-30076011e0.md): Import up to 10,000 leads into a lead list in a single request. Each lead requires at minimum a phone number.
- Conversations [List conversations](https://docs.rocketlead.com/list-conversations-30076012e0.md): List WhatsApp conversations with optional filters for search, campaign, tags, awaiting reply, and unread status. Returns paginated results.
- Conversations [Get conversation messages](https://docs.rocketlead.com/get-conversation-messages-30076013e0.md): Get all messages in a conversation, including sent and received WhatsApp messages with timestamps and delivery status.
- Conversations [Send message in conversation](https://docs.rocketlead.com/send-message-in-conversation-30076014e0.md): Send a WhatsApp message in an existing conversation. Supports text, image, video, audio, and document message types. For media messages, provide the file as base64 with MIME type.
- Conversations [Update conversation tags](https://docs.rocketlead.com/update-conversation-tags-30076015e0.md): Set the tags on a conversation. Replaces all existing tags with the provided list.
- Conversations [Toggle conversation read status](https://docs.rocketlead.com/toggle-conversation-read-status-30076016e0.md): Mark a conversation as read or unread.
- Conversations [Schedule a message](https://docs.rocketlead.com/schedule-a-message-30076017e0.md): Schedule a WhatsApp message to be sent at a specific time. Supports text and media messages with optional captions.
- Conversations [List scheduled messages](https://docs.rocketlead.com/list-scheduled-messages-30076018e0.md): List all pending scheduled messages for a conversation.
- Conversations [Cancel scheduled message](https://docs.rocketlead.com/cancel-scheduled-message-30076019e0.md): Cancel a pending scheduled message before it is sent.
- Conversations [List conversation tags](https://docs.rocketlead.com/list-conversation-tags-30076020e0.md): List all conversation tags defined in the workspace.
- Conversations [Create conversation tag](https://docs.rocketlead.com/create-conversation-tag-30076021e0.md): Create a new conversation tag with a name and optional color.
- Conversations [Delete conversation tag](https://docs.rocketlead.com/delete-conversation-tag-30076022e0.md): Delete a conversation tag by name. The tag will be removed from all conversations that have it.
- Conversations [Bulk conversation action](https://docs.rocketlead.com/bulk-conversation-action-30076023e0.md): Perform a bulk action on multiple conversations (e.g., mark as read, add tags, archive). Provide the action type and conversation IDs.
- Conversations [Get contact by phone](https://docs.rocketlead.com/get-contact-by-phone-30076024e0.md): Get contact details for a phone number including name, email, company, timezone, and notes.
- Conversations [Update contact](https://docs.rocketlead.com/update-contact-30076025e0.md): Update contact details for a phone number including name, email, company, timezone, and notes.
- Conversations [Send test message](https://docs.rocketlead.com/send-test-message-30076026e0.md): Send a test WhatsApp message from a specific account to a recipient phone number. Useful for testing account connectivity.
- Agents [List agents](https://docs.rocketlead.com/list-agents-30076027e0.md): List all AI agents configured in the workspace. Each agent has its own system prompt, model, temperature, and tone settings.
- Agents [Create agent](https://docs.rocketlead.com/create-agent-30076028e0.md): Create a new AI agent with a name, system prompt, model, temperature, tone, and response language settings. Optionally set as the default agent.
- Agents [Get agent usage stats](https://docs.rocketlead.com/get-agent-usage-stats-30076029e0.md): Get aggregate usage statistics for AI agents including total messages processed and tokens consumed.
- Agents [Get agent by ID](https://docs.rocketlead.com/get-agent-by-id-30076030e0.md): Get full details of a specific AI agent including name, system prompt, model, temperature, tone, and response language settings.
- Agents [Update agent](https://docs.rocketlead.com/update-agent-30076031e0.md): Update an AI agent's configuration including name, system prompt, model, temperature, tone, response language, and default status.
- Agents [Delete agent](https://docs.rocketlead.com/delete-agent-30076032e0.md): Delete an AI agent. Cannot be undone. If this was the default agent, no default agent will be set.
- Agents [Test agent with a message](https://docs.rocketlead.com/test-agent-with-a-message-30076033e0.md): Send a test message to an AI agent and get the agent's response. Useful for testing agent behavior before deploying.
- Agents [Get competitor analysis](https://docs.rocketlead.com/get-competitor-analysis-30076034e0.md): Get the saved competitor analysis for an agent, if one has been run previously.
- Agents [Run competitor analysis](https://docs.rocketlead.com/run-competitor-analysis-30076035e0.md): Run a new competitor analysis for an agent by providing competitor names. The analysis helps the agent understand competitive positioning.
- Warmup [Get warmup status](https://docs.rocketlead.com/get-warmup-status-30076036e0.md): Get warmup dashboard statistics for WhatsApp accounts. Shows warmup progress, daily message limits, and phase information. Supports filtering by search query, phase, and number of days.
- Warmup [Pause warmup for account](https://docs.rocketlead.com/pause-warmup-for-account-30076037e0.md): Pause the warmup process for a specific WhatsApp account. The account will stop sending warmup messages until resumed.
- Warmup [Resume warmup for account](https://docs.rocketlead.com/resume-warmup-for-account-30076038e0.md): Resume the warmup process for a previously paused WhatsApp account.
- Credits [Get current credit balance](https://docs.rocketlead.com/get-current-credit-balance-30076039e0.md): Get the current credit balance for the workspace including available credits and auto-top-up configuration.
- Credits [List credit transactions](https://docs.rocketlead.com/list-credit-transactions-30076040e0.md): List credit transaction history for the workspace. Returns a paginated ledger of all credit additions and deductions.
- Orders [Create a new order](https://docs.rocketlead.com/create-a-new-order-30076041e0.md): Create a new order to provision WhatsApp accounts. Each set specifies a quantity of accounts with shared display name, profile picture, business description, address, and category. Provisioning is enqueued automatically.
- Orders [List orders](https://docs.rocketlead.com/list-orders-30076042e0.md): List all orders for the workspace including their status, progress, and account counts.
- Orders [Get order details](https://docs.rocketlead.com/get-order-details-30076043e0.md): Get detailed information about a specific order including per-account provisioning progress. Returns paginated results.
- Provision [Start provisioning by requesting OTP](https://docs.rocketlead.com/start-provisioning-by-requesting-otp-30076044e0.md): Start the provisioning process for a user's own phone number by requesting an OTP verification code via SMS or voice call.
- Provision [Verify OTP and complete provisioning](https://docs.rocketlead.com/verify-otp-and-complete-provisioning-30076045e0.md): Complete the provisioning process by submitting the 6-digit OTP code. On success, the WhatsApp account is connected and profile is set up with the provided display name, bio, business details, and optional profile picture.
- Settings [Get workspace settings](https://docs.rocketlead.com/get-workspace-settings-30076046e0.md): Get all workspace settings including default timezone, webhook configuration, language, date format, and notification preferences.
- Settings [Update workspace settings](https://docs.rocketlead.com/update-workspace-settings-30076047e0.md): Update workspace settings. All fields are optional — only provided fields will be updated.
- Knowledge Base [List knowledge base sources](https://docs.rocketlead.com/list-knowledge-base-sources-30076048e0.md): List all knowledge base sources for a specific agent. Sources can be URLs, text, or files that the agent uses for context.
- Knowledge Base [Create knowledge base source](https://docs.rocketlead.com/create-knowledge-base-source-30076049e0.md): Add a new knowledge base source for an agent. Supported types: url (web page), text (raw content), file (uploaded document as base64). The content will be ingested and chunked for agent retrieval.
- Knowledge Base [Discover links from URL](https://docs.rocketlead.com/discover-links-from-url-30076050e0.md): Crawl a URL and discover sub-page links that can be added as knowledge base sources. Useful for bulk-adding website pages.
- Knowledge Base [Delete knowledge base source](https://docs.rocketlead.com/delete-knowledge-base-source-30076051e0.md): Delete a knowledge base source and all its ingested chunks. Cannot be undone.
- Knowledge Base [Re-ingest knowledge base source](https://docs.rocketlead.com/re-ingest-knowledge-base-source-30076052e0.md): Re-ingest a knowledge base source to refresh its content. Useful when the source URL content has changed.
- Knowledge Base [Get source chunks](https://docs.rocketlead.com/get-source-chunks-30076053e0.md): Get the ingested content chunks for a knowledge base source. Returns paginated results of the text segments used for agent retrieval.
- Knowledge Base [Get knowledge base stats](https://docs.rocketlead.com/get-knowledge-base-stats-30076054e0.md): Get aggregate statistics for an agent's knowledge base including total sources, chunks, and storage usage.