ColdSend

Showing 25 of 73 from the live probe.

• Create Campaign

  Create a new cold email campaign. This initializes a campaign with basic configuration. After creation, you'll need to: 1. Upload leads (recipients) 2. Configure sender inboxes 3. Design email content 4. Launch the campaign Args: name: Campaign name (minimum 8 characters) timezone: IANA timezone for scheduling (e.g. 'America/New_York') start_date: When to start sending (ISO 8601 format). Omit to start immediately upon activation.

• List Campaigns

  List all campaigns with filtering and pagination. Retrieve a paginated list of campaigns with optional filtering by status, search term, and sorting options. Args: status_filter: Filter by campaign status - DRAFT: Not yet launched - ACTIVE: Currently sending - PAUSED: Temporarily stopped - COMPLETED: Finished sending all emails - FAILED: Stopped due to errors search: Search campaigns by name (case-i

• Get Campaign

  Get detailed information about a specific campaign. Args: campaign_id: The UUID of the campaign to retrieve Returns: Full campaign details including configuration, statistics, and status Example: ```python campaign = await get_campaign("550e8400-e29b-41d4-a716-446655440000") print(f"Campaign status: {campaign['campaign']['status']}") ```

• Pause Campaign

  Pause an active campaign. Stops sending emails immediately. The campaign can be resumed later. Args: campaign_id: The UUID of the campaign to pause Returns: Updated campaign details with PAUSED status Example: ```python result = await pause_campaign("550e8400-e29b-41d4-a716-446655440000") print(f"Campaign paused: {result['message']}") ```

• Resume Campaign

  Resume a paused campaign. Restarts email sending from where it left off. Args: campaign_id: The UUID of the campaign to resume Returns: Updated campaign details with ACTIVE status Example: ```python result = await resume_campaign("550e8400-e29b-41d4-a716-446655440000") print(f"Campaign resumed: {result['message']}") ```

• Archive Campaign

  Archive a completed or paused campaign. Archiving is a one-way operation: the campaign becomes view-only, stops receiving replies, and can only be deleted afterwards. Only PAUSED or COMPLETED campaigns can be archived. Use this to clean up finished campaigns and free up linked inboxes. Args: campaign_id: The UUID of the campaign to archive Returns: Updated campaign details with ARCHIVED status Example: ```python

• Delete Campaign

  Delete a campaign permanently. ⚠️ WARNING: This action cannot be undone. All campaign data, including leads, emails, and analytics, will be permanently deleted. Args: campaign_id: The UUID of the campaign to delete Returns: Confirmation message Example: ```python result = await delete_campaign("550e8400-e29b-41d4-a716-446655440000") print(result['message']) ```

• Upload Leads CSV

  Upload leads from CSV to a campaign. Import recipient emails and metadata into a campaign for outreach. ## CSV Format Requirements - First row must be headers - Required column: `email` - Optional columns: `first_name`, `last_name`, `company`, `title`, etc. - Supports custom columns for personalization ## Column Mapping The mapping dictionary maps **lead field names** (keys) to **CSV column headers** (values). Standard fields are `emai

• List Leads

  List all leads in a campaign. Retrieve leads with pagination and optional filtering by status. Args: campaign_id: Campaign UUID status_filter: Filter by lead status - PENDING: Not yet sent - SENT: Email sent - REPLIED: Lead replied - BOUNCED: Email bounced search: Search leads by email address batch_id: Filter by upload batch ID page: Page number (1-based) limit: Number of results pe

• Delete Leads

  Delete one or more leads from a campaign. Remove leads in batch. Useful for cleaning up invalid leads or respecting unsubscribe requests. Args: campaign_id: Campaign UUID lead_ids: List of lead UUIDs to delete Returns: Confirmation message with number of deleted leads Example: ```python result = await delete_leads( campaign_id="550e8400-e29b-41d4-a716-446655440000", lead_ids=[

• Add Manual Lead

  Add a single lead manually to a campaign. Create one recipient entry without needing a CSV upload. Useful for adding individual prospects or testing. Args: campaign_id: Campaign UUID email: Email address (required) first_name: First name last_name: Last name company: Company name title: Job title custom_fields: Extra key-value pairs for personalization Returns: Created lead details with ID and status Example:

• Get Upload Progress

  Check the progress of an asynchronous lead upload job. After uploading leads via CSV, use this tool to poll for completion status, see how many leads were processed, and get error details for any invalid rows. Args: campaign_id: Campaign UUID job_id: Upload job ID from the leads.upload response Returns: Job progress including status, processed count, and error details Example: ```python progress = await get_upload_progress(

• Export Leads as CSV

  Export all leads from a campaign as CSV text. Returns the full CSV content as a string that can be parsed, saved, or forwarded to other systems. Args: campaign_id: Campaign UUID Returns: CSV text with headers and all lead rows Example: ```python csv_text = await export_leads( campaign_id="550e8400-e29b-41d4-a716-446655440000" ) lines = csv_text.strip().split("\n") print(f"Exported {len(lines) - 1} leads")

• Get Lead Details

  Get detailed information about a single lead. Returns the lead record including all fields, status, and interaction history. Args: campaign_id: Campaign UUID lead_id: Lead UUID Returns: Full lead details including custom fields and status Example: ```python lead = await get_lead( campaign_id="550e8400-e29b-41d4-a716-446655440000", lead_id="123e4567-e89b-12d3-a456-426614174000" ) print(f"Email:

• Update Lead

  Update a lead's information using merge-patch semantics. Only the fields provided will be updated; omitted fields remain unchanged. Custom fields are merged into the lead's existing custom_fields. Args: campaign_id: Campaign UUID lead_id: Lead UUID first_name: New first name last_name: New last name company: New company name title: New job title custom_fields: Custom fields to merge Returns: Updated lead detai

• Get Campaign Analytics

  Get workspace-wide campaign analytics and per-campaign breakdown. Returns aggregate KPIs (total campaigns, sends, average open/reply/bounce rates) and a per-campaign breakdown. ## Filtering - **status_filter**: Restrict to campaigns in a specific status - **from_date** / **to_date**: Restrict to campaigns launched within the given date range Args: status_filter: Filter by campaign status (DRAFT, ACTIVE, PAUSED, COMPLETED, FAILED) from

• Get Campaign Timeline

  Get daily time-series of email activity across all campaigns. Returns a contiguous daily series of sent/opened/replied/bounced counts and derived rates. Defaults to the last 90 days when no date range is supplied. Args: from_date: Start date (ISO 8601 date string). Defaults to 90 days ago. to_date: End date (ISO 8601 date string). Defaults to today. Returns: Timeline data with daily data points including sent, opened, replied, bounced counts

• Get Campaign CTR

  Get click-through-rate (CTR) metrics for a specific campaign. Returns CTR metrics including: - Total emails sent (denominator) - Unique verified/raw clicking leads (numerator) - Total verified/raw clicks - Verified and raw CTR percentages - Per sequence-step breakdown Click tracking must be enabled on the campaign for meaningful data. Args: campaign_id: The UUID of the campaign verified: If true, use verified (non-bot) click counts; otherwise

• Get Per-Link Click Breakdown

  Get per-link click breakdown for a specific campaign. Returns a breakdown of clicks per individual link in the campaign's emails, including: - Link index (position within the email body) - Sequence step number - Original destination URL - Verified and raw click counts - Unique verified leads per link Args: campaign_id: The UUID of the campaign verified: If true, use verified (non-bot) click counts Returns: Per-link click breakdown it

• List Domains

  List all domains in your workspace. Retrieve a paginated list of configured domains with their verification status. Args: status_filter: Filter by domain status (e.g. ACTIVE, PENDING, FAILED) page: Page number (1-based) limit: Number of results per page (1-100) Returns: List of domains with status information including: - Domain name and ID - Verification status (verified, pending, failed) - DNS record

• Get Domain

  Get detailed information about a specific domain. Includes DNS records, verification status, and configuration details. Args: domain_id: Domain UUID Returns: Full domain details including: - Basic info (name, status, created_at) - DNS records (MX, TXT, CNAME) - Verification status (Cloudflare, Stalwart) - Nameserver configuration - Inbox count and limits Example: ```python

• Add Domain

  Add a new domain to your workspace. This initiates the domain verification process. You'll need to configure DNS records as instructed to complete verification. ## Verification Process 1. Add domain to ColdSend (this endpoint) 2. Configure DNS records at your domain registrar 3. Wait for DNS propagation (5-30 minutes) 4. Verify DNS records (ColdSend auto-checks periodically) 5. Domain becomes active once verified ## Required DNS Records

• Get Domain Activation Progress

  Get domain activation progress and next steps. Provides a detailed breakdown of what's completed and what's pending in the domain setup process. Args: domain_id: Domain UUID Returns: Progress report including: - Overall completion percentage - Step-by-step progress - Pending actions required - Estimated time to completion Example: ```python progress = await get_domain_activatio

• Delete Domain

  Delete a domain permanently. ⚠️ WARNING: This will remove the domain from your workspace. Any inboxes using this domain will be affected. Prerequisites: - All inboxes using this domain must be deleted first - Domain cannot have active campaigns Args: domain_id: Domain UUID to delete Returns: Deletion confirmation Example: ```python result = await delete_domain("550e8400-e29b-41d4-a716-446655440000")

• Activate Domain

  Trigger domain activation and DNS verification. Initiates the DNS verification process for a domain that has been added but not yet activated. ColdSend will check DNS records and provision email infrastructure once verified. Args: domain_id: Domain UUID to activate Returns: Activation status with DNS verification result, progress URL, and estimated completion time Example: ```python result = await activate_domain("550e8400-e29b-