Skip to main content
Loops.so logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: LOOPS_SO
  • Version: 20261101_00

Tools

Slug: LOOPS_SO_CREATE_CONTACTCreate a contact in your Loops audience using an email address and optional supported properties such as name, subscription status and mailing lists. Subscription defaults to true.

Input Parameters

string
required
The contact’s email address. This is the unique identifier for the contact.
string
Custom source value to replace the default ‘API’ source attribution.
string
Unique user ID from your external application for linking contacts.
string
The contact’s last name.
string
The contact’s first name.
string
Segment users into groups. A contact can only be in one user group at a time.
boolean
Whether the contact should receive campaign and loops emails. Defaults to true if not specified.
object
Key-value pairs mapping mailing list IDs to boolean subscription status. Keys are mailing list IDs, values indicate subscription status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_CREATE_CONTACT_PROPERTYTool to add a custom contact property to your Loops team. Use when you need to store additional contact data beyond default fields. Properties must have unique names in camelCase format and a specified data type (string, number, boolean, or date).

Input Parameters

string
required
The name of the property in camelCase format (e.g., planName, favoriteColor). This will be used to identify the property in your contact data.
string ("string" | "number" | "boolean" | "date")
required
The property’s data type. Must be one of: string, number, boolean, or date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_DELETE_CONTACTTool to delete a contact by email address or user ID. Use when you need to remove a contact from Loops. Either email or userId must be provided to identify the contact.

Input Parameters

string
The contact’s email address to identify which contact to delete
string
The contact’s userId value to identify which contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_FIND_CONTACTSearch for a contact by email or userId and retrieve contact details including subscription status. Exactly one of email or userId must be provided per request.

Input Parameters

string
The contact’s email address to search for. Must be URI-encoded. Only one of email or userId is allowed per request.
string
The contact’s unique user ID to search for. Only one of email or userId is allowed per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_GET_CONTACT_PROPERTIESTool to retrieve a list of your account’s contact properties from Loops.so. Use when you need to view all available contact properties or filter to only custom properties created by your team.

Input Parameters

string
Use ‘custom’ to filter results to only custom properties created by your team. Omit this parameter to retrieve all properties (both standard and custom).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_GET_DEDICATED_SENDING_IPSTool to retrieve a list of Loops’ dedicated sending IP addresses. Use when you need to get IP addresses for whitelisting purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_GET_MAILING_LISTSTool to retrieve all mailing lists associated with your Loops account. Use when you need to browse or manage mailing list information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_LIST_CUSTOM_FIELDSTool to retrieve a list of custom contact properties. Use when you need to view available custom fields for contacts. Note: This endpoint is deprecated in favor of ‘List contact properties’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_LIST_TRANSACTIONAL_EMAILSTool to retrieve a list of published transactional emails. Use when you need to view all available transactional email templates. Supports pagination with perPage and cursor parameters.

Input Parameters

string
A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response.
integer
How many results to return in each request. Must be between 10 and 50. Default: 20

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_SEND_EVENTSend an event for a contact to track actions and trigger automated Loops workflows. The request can also update mailing list subscriptions.

Input Parameters

string
The contact’s email address. Required if userId is not provided.
string
The contact’s unique user ID. Required if email is not provided.
string
required
The name of the event to trigger.
object
Mailing list subscriptions as key-value pairs. Keys are list IDs, values are boolean (true to add, false to remove).
string
Optional idempotency key (up to 100 characters) to avoid duplicate requests within 24 hours.
object
Event property data as key-value pairs. Values can be string, number, boolean, or date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_TEST_API_KEYTool to test API key validity and retrieve team information. Use to verify API credentials are working correctly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOOPS_SO_UPDATE_CONTACTTool to update an existing contact by email or userId. Use when you need to modify contact properties or re-subscribe contacts. Creates a new contact if no matching record exists.

Input Parameters

string
Contact’s email address. Creates new contact if none exists. Required if userId is not provided.
string
Custom source value replacing default ‘API’
string
Unique user identifier from external applications. Required if email is not provided.
string
Contact’s last name
string
Contact’s first name
string
Single group for user segmentation
boolean
Determines campaign/loop email eligibility. Setting to true will re-subscribe previously unsubscribed contacts.
object
Key-value pairs of list IDs with boolean subscription status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not