Skip to main content
Loops logo

Overview

Add Loops to any ModuleX agent or workflow. Manage contacts and send emails with Loops. Create and manage contacts, send transactional emails, and trigger event-based automations against the Loops REST API (app.loops.so/api/v1).
Categories: Marketing & Advertising · Email Marketing · Automation · Auth: API Key · Actions: 10

Authentication

API Key Authentication

Authenticate using your Loops API key
1

Step 1

Log in to your Loops account at https://app.loops.so
2

Step 2

Go to Settings > API
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

Required Credentials

Available Actions

Parameters

string
required
The email address for the new contact
string
The contact first name
string
The contact last name
string
Custom source value replacing the default “API”
boolean
Whether the contact receives campaign emails (defaults to true)
string
Group to segment the contact into (one group per contact)
string
Unique user identifier from your application
object
Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
object
Custom contact properties as key-value pairs (string, number, boolean, or date values)

Response

Parameters

string
The contact email address (at least one of email or user_id is required)
string
The contact userId (at least one of email or user_id is required)
string
The contact first name
string
The contact last name
string
Custom source value replacing the default “API”
boolean
Whether the contact receives campaign emails (sending true re-subscribes unsubscribed contacts)
string
Group to segment the contact into (one group per contact)
object
Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
object
Custom contact properties as key-value pairs (send null to reset a property)

Response

Parameters

string
The contact email address to search for (at least one of email or user_id is required)
string
The contact userId to search for (at least one of email or user_id is required)

Response

Parameters

string
The email address of the contact to delete (at least one of email or user_id is required)
string
The userId of the contact to delete (at least one of email or user_id is required)

Response

Parameters

string
required
The email address of the recipient
string
required
The ID of the transactional email template to send
object
Template data variables as key-value pairs (string or number values)
boolean
Whether to create the recipient as a contact if they do not already exist (default: false)
array
Array of file attachments. Each object must have filename (string), contentType (MIME type string), and data (base64-encoded string).

Response

Parameters

string
required
The name of the event to trigger
string
The email address of the contact (at least one of email or user_id is required)
string
The userId of the contact (at least one of email or user_id is required)
object
Event data as key-value pairs (string, number, boolean, or date values)
object
Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)

Response

Response

Parameters

string
Number of results per page (10-50, default: 20)
string
Pagination cursor from a previous response to fetch the next page

Response

Parameters

string
required
The property name in camelCase format (e.g., “favoriteColor”)
string
required
The property data type (e.g., “string”, “number”, “boolean”, “date”)

Response

Parameters

string
Filter type: “all” for all properties (default) or “custom” for custom properties only

Response

Limits & Quotas

  • Loops applies per-account API rate limits; check your plan in the Loops dashboard for current values.
  • list_transactional_emails accepts per_page (10-50, default 20) and a cursor for pagination; the response carries a pagination block with next_cursor/next_page for fetching subsequent pages.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Mutating endpoints also return HTTP 200 with {"success": false, "message": ...} for business-logic failures, which is surfaced as error.

Klaviyo

SendGrid

AgentMail