Files
AutoGPT/docs/integrations/block-integrations/smartlead/campaign.md
Nicholas Tindle 90466908a8 refactor(docs): restructure platform docs for GitBook and remove MkDo… (#11825)
<!-- Clearly explain the need for these changes: -->
we met some reality when merging into the docs site but this fixes it
### Changes 🏗️
updates paths, adds some guides
<!-- Concisely describe all of the changes made in this pull request:
-->
update to match reality
### Checklist 📋

#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
  <!-- Put your test plan here: -->
  - [x] deploy it and validate

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Aligns block integrations documentation with GitBook.
> 
> - Changes generator default output to
`docs/integrations/block-integrations` and writes overview `README.md`
and `SUMMARY.md` at `docs/integrations/`
> - Adds GitBook frontmatter and hint syntax to overview; prefixes block
links with `block-integrations/`
> - Introduces `generate_summary_md` to build GitBook navigation
(including optional `guides/`)
> - Preserves per-block manual sections and adds optional `extras` +
file-level `additional_content`
> - Updates sync checker to validate parent `README.md` and `SUMMARY.md`
> - Rewrites `docs/integrations/README.md` with GitBook frontmatter and
updated links; adds `docs/integrations/SUMMARY.md`
> - Adds new guides: `guides/llm-providers.md`,
`guides/voice-providers.md`
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
fdb7ff8111. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co>
2026-01-23 06:18:16 +00:00

4.4 KiB

Smartlead Campaign

Blocks for managing email outreach campaigns in SmartLead.

Add Lead To Campaign

What it is

Add a lead to a campaign in SmartLead

How it works

This block adds up to 100 leads to an existing SmartLead campaign using the SmartLead API. Each lead includes contact details and optional custom fields for personalization.

Configure upload settings to control duplicate handling and campaign status. The response includes counts for successful uploads, duplicates, and invalid entries.

Inputs

Input Description Type Required
campaign_id The ID of the campaign to add the lead to int Yes
lead_list An array of JSON objects, each representing a lead's details. Can hold max 100 leads. List[LeadInput] No
settings Settings for lead upload LeadUploadSettings No

Outputs

Output Description Type
error Error message if the lead was not added to the campaign str
campaign_id The ID of the campaign the lead was added to (passed through) int
upload_count The number of leads added to the campaign int
already_added_to_campaign The number of leads that were already added to the campaign int
duplicate_count The number of emails that were duplicates int
invalid_email_count The number of emails that were invalidly formatted int
is_lead_limit_exhausted Whether the lead limit was exhausted bool
lead_import_stopped_count The number of leads that were not added to the campaign because the lead import was stopped int

Possible use case

Lead Import: Bulk import leads from CRM exports, web forms, or enrichment services.

Campaign Automation: Automatically add qualifying leads to outreach campaigns.

Multi-Source Aggregation: Consolidate leads from multiple sources into unified campaigns.


Create Campaign

What it is

Create a campaign in SmartLead

How it works

This block creates a new email campaign in SmartLead using the SmartLead API. Provide a campaign name and the block returns the created campaign's ID and metadata.

Use the campaign ID with other SmartLead blocks to add leads, configure sequences, and manage the campaign.

Inputs

Input Description Type Required
name The name of the campaign str Yes

Outputs

Output Description Type
error Error message if the search failed str
id The ID of the created campaign int
name The name of the created campaign str
created_at The date and time the campaign was created str

Possible use case

Dynamic Campaigns: Create campaigns programmatically for different products or segments.

Workflow Automation: Spin up new outreach campaigns as part of sales or marketing workflows.

Campaign Templating: Create campaigns from templates with standardized configurations.


Save Campaign Sequences

What it is

Save sequences within a campaign

How it works

This block saves email sequences to an existing SmartLead campaign. Sequences define the email content, timing, and follow-up structure for the campaign's outreach.

Each sequence includes the email subject, body, and delay settings for automated follow-up emails.

Inputs

Input Description Type Required
campaign_id The ID of the campaign to save sequences for int Yes
sequences The sequences to save List[Sequence] No

Outputs

Output Description Type
error Error message if the sequences were not saved str
data Data from the API Dict[str, Any] | str
message Message from the API str

Possible use case

Email Automation: Define multi-step email sequences for nurturing leads.

A/B Testing: Create variant sequences to test different messaging approaches.

Campaign Configuration: Set up complete outreach flows programmatically.