Loops

Nutzungsanweisungen

Integrate Loops into the workflow. Create and manage contacts, send transactional emails, and trigger event-based automations.

Tools

`loops_create_contact`

Create a new contact in your Loops audience with an email address and optional properties like name, user group, and mailing list subscriptions.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Ja	The email address for the new contact
`firstName`	string	Nein	The contact first name
`lastName`	string	Nein	The contact last name
`source`	string	Nein	Custom source value replacing the default "API"
`subscribed`	boolean	Nein	Whether the contact receives campaign emails (defaults to true)
`userGroup`	string	Nein	Group to segment the contact into (one group per contact)
`userId`	string	Nein	Unique user identifier from your application
`mailingLists`	json	Nein	Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
`customProperties`	json	Nein	Custom contact properties as key-value pairs (string, number, boolean, or date values)

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the contact was created successfully
`id`	string	The Loops-assigned ID of the created contact

`loops_update_contact`

Update an existing contact in Loops by email or userId. Creates a new contact if no match is found (upsert). Can update name, subscription status, user group, mailing lists, and custom properties.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Nein	The contact email address (at least one of email or userId is required)
`userId`	string	Nein	The contact userId (at least one of email or userId is required)
`firstName`	string	Nein	The contact first name
`lastName`	string	Nein	The contact last name
`source`	string	Nein	Custom source value replacing the default "API"
`subscribed`	boolean	Nein	Whether the contact receives campaign emails (sending true re-subscribes unsubscribed contacts)
`userGroup`	string	Nein	Group to segment the contact into (one group per contact)
`mailingLists`	json	Nein	Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
`customProperties`	json	Nein	Custom contact properties as key-value pairs (send null to reset a property)

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the contact was updated successfully
`id`	string	The Loops-assigned ID of the updated or created contact

`loops_find_contact`

Find a contact in Loops by email address or userId. Returns an array of matching contacts with all their properties including name, subscription status, user group, and mailing lists.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Nein	The contact email address to search for (at least one of email or userId is required)
`userId`	string	Nein	The contact userId to search for (at least one of email or userId is required)

Ausgabe

Parameter	Typ	Beschreibung
`contacts`	array	Array of matching contact objects (empty array if no match found)
↳ `id`	string	Loops-assigned contact ID
↳ `email`	string	Contact email address
↳ `firstName`	string	Contact first name
↳ `lastName`	string	Contact last name
↳ `source`	string	Source the contact was created from
↳ `subscribed`	boolean	Whether the contact receives campaign emails
↳ `userGroup`	string	Contact user group
↳ `userId`	string	External user identifier
↳ `mailingLists`	object	Mailing list IDs mapped to subscription status
↳ `optInStatus`	string	Double opt-in status: pending, accepted, rejected, or null

`loops_delete_contact`

Delete a contact from Loops by email address or userId. At least one identifier must be provided.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Nein	The email address of the contact to delete (at least one of email or userId is required)
`userId`	string	Nein	The userId of the contact to delete (at least one of email or userId is required)

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the contact was deleted successfully
`message`	string	Status message from the API

`loops_send_transactional_email`

Send a transactional email to a recipient using a Loops template. Supports dynamic data variables for personalization and optionally adds the recipient to your audience.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Ja	The email address of the recipient
`transactionalId`	string	Ja	The ID of the transactional email template to send
`dataVariables`	json	Nein	Template data variables as key-value pairs (string or number values)
`addToAudience`	boolean	Nein	Whether to create the recipient as a contact if they do not already exist (default: false)
`attachments`	json	Nein	Array of file attachments. Each object must have filename (string), contentType (MIME type string), and data (base64-encoded string).

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the transactional email was sent successfully

`loops_send_event`

Send an event to Loops to trigger automated email sequences for a contact. Identify the contact by email or userId and include optional event properties and mailing list changes.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`email`	string	Nein	The email address of the contact (at least one of email or userId is required)
`userId`	string	Nein	The userId of the contact (at least one of email or userId is required)
`eventName`	string	Ja	The name of the event to trigger
`eventProperties`	json	Nein	Event data as key-value pairs (string, number, boolean, or date values)
`mailingLists`	json	Nein	Mailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the event was sent successfully

`loops_list_mailing_lists`

Retrieve all mailing lists from your Loops account. Returns each list with its ID, name, description, and public/private status.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication

Ausgabe

Parameter	Typ	Beschreibung
`mailingLists`	array	Array of mailing list objects
↳ `id`	string	The mailing list ID
↳ `name`	string	The mailing list name
↳ `description`	string	The mailing list description (null if not set)
↳ `isPublic`	boolean	Whether the list is public or private

`loops_list_transactional_emails`

Retrieve a list of published transactional email templates from your Loops account. Returns each template with its ID, name, last updated timestamp, and data variables.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`perPage`	string	Nein	Number of results per page (10-50, default: 20)
`cursor`	string	Nein	Pagination cursor from a previous response to fetch the next page

Ausgabe

Parameter	Typ	Beschreibung
`transactionalEmails`	array	Array of published transactional email templates
↳ `id`	string	The transactional email template ID
↳ `name`	string	The template name
↳ `lastUpdated`	string	Last updated timestamp
↳ `dataVariables`	array	Template data variable names
`pagination`	object	Pagination information
↳ `totalResults`	number	Total number of results
↳ `returnedResults`	number	Number of results returned
↳ `perPage`	number	Results per page
↳ `totalPages`	number	Total number of pages
↳ `nextCursor`	string	Cursor for next page (null if no more pages)
↳ `nextPage`	string	URL for next page (null if no more pages)

`loops_create_contact_property`

Create a new custom contact property in your Loops account. The property name must be in camelCase format.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`name`	string	Ja	The property name in camelCase format (e.g., "favoriteColor")
`type`	string	Ja	The property data type (e.g., "string", "number", "boolean", "date")

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the contact property was created successfully

`loops_list_contact_properties`

Retrieve a list of contact properties from your Loops account. Returns each property with its key, label, and data type. Can filter to show all properties or only custom ones.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`apiKey`	string	Ja	Loops API key for authentication
`list`	string	Nein	Filter type: "all" for all properties (default) or "custom" for custom properties only

Ausgabe

Parameter	Typ	Beschreibung
`properties`	array	Array of contact property objects
↳ `key`	string	The property key (camelCase identifier)
↳ `label`	string	The property display label
↳ `type`	string	The property data type (string, number, boolean, date)

Loops

On this page