SmartLead

Comprehensive SmartLead API integration for email marketing automation

Actions37

Overview

This node integrates with the SmartLead API to manage email marketing campaigns. Specifically, the "Get by ID" operation under the 🎯 Campaign Management resource retrieves detailed information about a single campaign using its unique campaign ID.

Typical use cases include:

  • Fetching campaign details for monitoring or reporting.
  • Retrieving campaign metadata before performing updates or analytics.
  • Integrating campaign data into workflows that require campaign-specific context.

For example, you might use this node to get the status and settings of a particular email campaign before deciding whether to pause or update it.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to retrieve.
Additional Fields Optional parameters to refine the request:
- Limit Number of results to return (used in some operations but not relevant for "Get by ID").
- Offset Number of results to skip (used in some operations but not relevant for "Get by ID").
- Status Filter campaigns by status: Active, Paused, or Stopped (not applicable for "Get by ID").

Note: For the Get by ID operation, only the Campaign ID is required and used. The additional fields are generally for other operations like listing multiple campaigns.

Output

The output JSON contains the detailed data of the requested campaign as returned by the SmartLead API. This typically includes:

  • Campaign metadata such as name, ID, creation date.
  • Current status (e.g., active, paused).
  • Scheduling and sequence information if available.
  • Other campaign-specific settings and statistics.

The output is structured as an array of JSON objects, each representing one campaign (in this case, just one). There is no binary data output for this operation.

Example output snippet (simplified):

[
  {
    "id": "12345",
    "name": "Spring Sale Campaign",
    "status": "ACTIVE",
    "created_at": "2024-01-15T10:00:00Z",
    "schedule": { ... },
    "sequence": [ ... ],
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the SmartLead API.
  • The node makes HTTP requests to https://server.smartlead.ai/api/v1.
  • Ensure the API key has permissions to read campaign data.
  • No additional environment variables are needed beyond the configured API credential.

Troubleshooting

  • Invalid Campaign ID: If the provided campaign ID does not exist or is malformed, the API will likely return a 404 error. Verify the campaign ID is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm the API key is set up correctly in n8n credentials.
  • Network Issues: Connectivity problems can cause request timeouts or failures. Check network access to the SmartLead API endpoint.
  • Unexpected Response Format: If the API changes or returns unexpected data, the node may fail to parse the response. Review API documentation or update the node accordingly.

Links and References

Discussion