ByteChef LogoByteChef

Loops

Loops is an email marketing and transactional email platform built for modern SaaS companies, helping businesses automate onboarding, product updates, and lifecycle messaging with simple workflows, API integrations, and scalable contact management.

Categories: Advertising

Type: loops/v1


Connections

Version: 1

API Key

Properties

NameLabelTypeDescriptionRequired
tokenAPI KeySTRINGTo find your API key go to Settings -> API in Loops and click Generate key.true

Connection Setup

Generate API Key

  1. Login to your Loops
  2. Click here to go to Settings.
  3. Click on API.
  4. Click on Generate key button.
  5. By clicking here you can copy your API Key.

Actions

Create Contact

Name: createContact

Create a new contact with an email address and any other contact properties.

Properties

NameLabelTypeDescriptionRequired
emailEmail AddressSTRINGThe contact’s email address.true
firstNameFirst NameSTRINGThe contact’s first name.false
lastNameLast NameSTRINGThe contact’s last name.false
userGroupUser GroupSTRINGYou can use groups to segment users when sending emails. Currently, a contact can only be in one user group. Groups like “Users”, “VIPs”, “Investors” or “Customers”false
userIdUser IDSTRINGA unique user ID (for example, from an external application).false
mailingListsMailing ListsARRAY
Items [STRING]
List of mailing lists the user will be subscribed to.false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "email" : "",
    "firstName" : "",
    "lastName" : "",
    "userGroup" : "",
    "userId" : "",
    "mailingLists" : [ "" ]
  },
  "type" : "loops/v1/createContact"
}

Output

Type: OBJECT

Properties

NameTypeDescription
successBOOLEAN
Options true, false
Indicates whether the contact was created successfully.
idSTRINGThe internal ID of the new contact.

Output Example

{
  "success" : false,
  "id" : ""
}

How to find Mailing List ID

  1. Go to Setting.
  2. Click on Lists.
  3. There you will see your Mailing lists.
  4. Copy ID of the desired mailing list.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page