AptlyStar

Loops

Manage contacts and send emails with Loops

使用方法

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

ツール

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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringはいThe email address for the new contact
firstNamestringいいえThe contact first name
lastNamestringいいえThe contact last name
sourcestringいいえCustom source value replacing the default "API"
subscribedbooleanいいえWhether the contact receives campaign emails (defaults to true)
userGroupstringいいえGroup to segment the contact into (one group per contact)
userIdstringいいえUnique user identifier from your application
mailingListsjsonいいえMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
customPropertiesjsonいいえCustom contact properties as key-value pairs (string, number, boolean, or date values)

出力

パラメータ型説明
successbooleanWhether the contact was created successfully
idstringThe 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringいいえThe contact email address (at least one of email or userId is required)
userIdstringいいえThe contact userId (at least one of email or userId is required)
firstNamestringいいえThe contact first name
lastNamestringいいえThe contact last name
sourcestringいいえCustom source value replacing the default "API"
subscribedbooleanいいえWhether the contact receives campaign emails (sending true re-subscribes unsubscribed contacts)
userGroupstringいいえGroup to segment the contact into (one group per contact)
mailingListsjsonいいえMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)
customPropertiesjsonいいえCustom contact properties as key-value pairs (send null to reset a property)

出力

パラメータ型説明
successbooleanWhether the contact was updated successfully
idstringThe 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringいいえThe contact email address to search for (at least one of email or userId is required)
userIdstringいいえThe contact userId to search for (at least one of email or userId is required)

出力

パラメータ型説明
contactsarrayArray of matching contact objects (empty array if no match found)
↳ idstringLoops-assigned contact ID
↳ emailstringContact email address
↳ firstNamestringContact first name
↳ lastNamestringContact last name
↳ sourcestringSource the contact was created from
↳ subscribedbooleanWhether the contact receives campaign emails
↳ userGroupstringContact user group
↳ userIdstringExternal user identifier
↳ mailingListsobjectMailing list IDs mapped to subscription status
↳ optInStatusstringDouble 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringいいえThe email address of the contact to delete (at least one of email or userId is required)
userIdstringいいえThe userId of the contact to delete (at least one of email or userId is required)

出力

パラメータ型説明
successbooleanWhether the contact was deleted successfully
messagestringStatus 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringはいThe email address of the recipient
transactionalIdstringはいThe ID of the transactional email template to send
dataVariablesjsonいいえTemplate data variables as key-value pairs (string or number values)
addToAudiencebooleanいいえWhether to create the recipient as a contact if they do not already exist (default: false)
attachmentsjsonいいえArray of file attachments. Each object must have filename (string), contentType (MIME type string), and data (base64-encoded string).

出力

パラメータ型説明
successbooleanWhether 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
emailstringいいえThe email address of the contact (at least one of email or userId is required)
userIdstringいいえThe userId of the contact (at least one of email or userId is required)
eventNamestringはいThe name of the event to trigger
eventPropertiesjsonいいえEvent data as key-value pairs (string, number, boolean, or date values)
mailingListsjsonいいえMailing list IDs mapped to boolean values (true to subscribe, false to unsubscribe)

出力

パラメータ型説明
successbooleanWhether 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication

出力

パラメータ型説明
mailingListsarrayArray of mailing list objects
↳ idstringThe mailing list ID
↳ namestringThe mailing list name
↳ descriptionstringThe mailing list description (null if not set)
↳ isPublicbooleanWhether 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
perPagestringいいえNumber of results per page (10-50, default: 20)
cursorstringいいえPagination cursor from a previous response to fetch the next page

出力

パラメータ型説明
transactionalEmailsarrayArray of published transactional email templates
↳ idstringThe transactional email template ID
↳ namestringThe template name
↳ lastUpdatedstringLast updated timestamp
↳ dataVariablesarrayTemplate data variable names
paginationobjectPagination information
↳ totalResultsnumberTotal number of results
↳ returnedResultsnumberNumber of results returned
↳ perPagenumberResults per page
↳ totalPagesnumberTotal number of pages
↳ nextCursorstringCursor for next page (null if no more pages)
↳ nextPagestringURL 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
namestringはいThe property name in camelCase format (e.g., "favoriteColor")
typestringはいThe property data type (e.g., "string", "number", "boolean", "date")

出力

パラメータ型説明
successbooleanWhether 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.

入力

パラメータ型必須説明
apiKeystringはいLoops API key for authentication
liststringいいえFilter type: "all" for all properties (default) or "custom" for custom properties only

出力

パラメータ型説明
propertiesarrayArray of contact property objects
↳ keystringThe property key (camelCase identifier)
↳ labelstringThe property display label
↳ typestringThe property data type (string, number, boolean, date)

On this page