Ruby SDK

bundle add loops_sdk

gem install loops_sdk

require "loops_sdk"

LoopsSdk.configure do |config|
  config.api_key = 'your_api_key'
end

begin

  response = LoopsSdk::Transactional.send(
    transactional_id: "closfz8ui02yq...",
    email: "[email protected]",
    data_variables: {
      loginUrl: "https://app.domain.com/login?code=1234567890"
    }
  )

rescue LoopsSdk::APIError => e
  # Do something if there is an error from the API
end

response LoopsSdk::ApiKey.test

{
  "success": true,
  "teamName": "Company name"
}

{
  "error": "Invalid API key"
}

response = LoopsSdk::Contacts.create(email: "[email protected]")

contact_properties = {
  firstName: "Bob" /* Default property */,
  favoriteColor: "Red" /* Custom property */,
};
mailing_lists = {
  cm06f5v0e45nf0ml5754o9cix: true,
  cm16k73gq014h0mmj5b6jdi9r: false,
};
response = LoopsSdk::Contacts.create(
  email: "[email protected]",
  properties: contact_properties,
  mailing_lists: mailing_lists
)

{
  "success": true,
  "id": "id_of_contact"
}

{
  "success": false,
  "message": "An error message here."
}

contact_properties = {
  firstName: "Bob" /* Default property */,
  favoriteColor: "Blue" /* Custom property */,
};
response = LoopsSdk::Contacts.update(
  email: "[email protected]",
  properties: contact_properties
)

# Updating a contact's email address using userId
response = LoopsSdk::Contacts.update(
  email: "[email protected]",
  properties: {
    userId: "1234",
  })

{
  "success": true,
  "id": "id_of_contact"
}

{
  "success": false,
  "message": "An error message here."
}

response = LoopsSdk::Contacts.find(email: "[email protected]")

response = LoopsSdk::Contacts.find(userId: "12345")

[
  {
    "id": "cll6b3i8901a9jx0oyktl2m4u",
    "email": "[email protected]",
    "firstName": "Bob",
    "lastName": null,
    "source": "API",
    "subscribed": true,
    "userGroup": "",
    "userId": "12345",
    "mailingLists": {
      "cm06f5v0e45nf0ml5754o9cix": true
    },
    "favoriteColor": "Blue" /* Custom property */
  }
]

response = LoopsSdk::Contacts.delete(email: "[email protected]")

response = LoopsSdk::Contacts.delete(userId: "12345")

{
  "success": true,
  "message": "Contact deleted."
}

{
  "success": false,
  "message": "An error message here."
}

response = LoopsSdk::MailingLists.list

[
  {
    "id": "cm06f5v0e45nf0ml5754o9cix",
    "name": "Main list"
  },
  {
    "id": "cm16k73gq014h0mmj5b6jdi9r",
    "name": "Investors"
  }
]

response = LoopsSdk::Events.send(
  event_name: "signup",
  email: "[email protected]"
)

response = LoopsSdk::Events.send(
  event_name: "signup",
  email: "[email protected]",
  event_properties: {
    username: "user1234",
    signupDate: "2024-03-21T10:09:23Z",
  },
  mailing_lists: {
    cm06f5v0e45nf0ml5754o9cix: true,
    cm16k73gq014h0mmj5b6jdi9r: false,
  },
})

# In this case with both email and userId present, the system will look for a contact with either a
#  matching `email` or `user_id` value.
# If a contact is found for one of the values (e.g. `email`), the other value (e.g. `user_id`) will be updated.
# If a contact is not found, a new contact will be created using both `email` and `user_id` values.
# Any values added in `contact_properties` will also be updated on the contact.
response = LoopsSdk::Events.send(
  event_name: "signup",
  email: "[email protected]",
  user_id: "1234567890",
  contact_properties: {
    firstName: "Bob",
    plan: "pro",
  },
})

{
  "success": true
}

{
  "success": false,
  "message": "An error message here."
}

response = LoopsSdk::Transactional.send(
  transactional_id: "clfq6dinn000yl70fgwwyp82l",
  email: "[email protected]",
  data_variables: {
    loginUrl: "https://myapp.com/login/",
  },
)

# Please contact us to enable attachments on your account.
response = LoopsSdk::Transactional.send(
  transactional_id: "clfq6dinn000yl70fgwwyp82l",
  email: "[email protected]",
  data_variables: {
    loginUrl: "https://myapp.com/login/",
  },
  attachments: [
    {
      filename: "presentation.pdf",
      content_type: "application/pdf",
      data: "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPD...",
    },
  ],
})

{
  "success": true
}

{
  "success": false,
  "path": "dataVariables",
  "message": "There are required fields for this email. You need to include a 'dataVariables' object with the required fields."
}

{
  "success": false,
  "error": {
    "path": "dataVariables",
    "message": "Missing required fields: login_url"
  },
  "transactionalId": "clfq6dinn000yl70fgwwyp82l"
}

response LoopsSdk::CustomFields.list

[
  {
    "key": "favoriteColor",
    "label": "Favorite Color",
    "type": "string"
  },
  {
    "key": "plan",
    "label": "Plan",
    "type": "string"
  }
]