Actions33
- Campaign Actions
- Contact Actions
- Field Actions
- Opt-In Actions
- Opt-in-Case Actions
- Sign in Form Actions
- Storage-Field Actions
- Tag Actions
Overview
This node integrates with the 4leads platform, specifically allowing users to interact with various resources such as campaigns, contacts, opt-ins, tags, and more. For the Opt-In resource with the Get operation, the node retrieves opt-in data from 4leads.
Use cases include:
- Fetching details of a specific opt-in by its ID.
- Searching and retrieving multiple opt-ins based on search criteria, pagination, and page size.
Practical examples:
- Retrieve a single opt-in record to verify subscription status or details.
- List multiple opt-ins filtered by a search string (e.g., email domain) and paginate through results for reporting or synchronization purposes.
Properties
| Name | Meaning |
|---|---|
Search for multiple results (bReturnAll) |
Boolean flag to choose between returning a single opt-in object (false) or a list of opt-in objects (true). |
Opt-In (optinId) |
When bReturnAll is false, select a specific opt-in either from a searchable list or by entering its numeric ID. |
Additional Fields (optinQs) |
When bReturnAll is true, allows specifying additional query parameters: - Search String: Text to filter opt-ins by name fields (e.g., searching for names containing "@muster.de"). - Page Size: Number of results per page (e.g., 5, 10, 20, 50, 200). - Page Number: The page number of results to retrieve (starting at 1). |
Output
The node outputs JSON data representing the retrieved opt-in(s):
- If fetching a single opt-in (
bReturnAll= false), the output is a JSON object with the opt-in's details. - If fetching multiple opt-ins (
bReturnAll= true), the output is an array of opt-in objects matching the search criteria and pagination settings.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the 4leads platform.
- The node depends on internal handlers that communicate with 4leads API endpoints to fetch opt-in data.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
- Invalid Opt-In ID: If the provided opt-in ID does not match the expected numeric format, the node will reject it due to regex validation. Ensure the ID contains only digits.
- Empty Results: When using search parameters, if no opt-ins match the criteria, the node returns an empty array. Adjust search strings or pagination accordingly.
- API Authentication Errors: Failure to authenticate with the 4leads API (e.g., invalid or missing API key) will cause errors. Verify the API credentials in the node configuration.
- Pagination Issues: Specifying a page number beyond available pages may result in empty responses. Confirm total available pages before requesting higher page numbers.
Links and References
- 4leads Official Website — For general platform information.
- 4leads API documentation (not publicly linked here) — Consult your 4leads account or support for detailed API specs related to opt-ins.