Skip to main content

Eloqua library

Project description

Eloqua Python Connector

Python 3 library for using the Eloqua API

Eloqua API Documentation Here


Manage your connection

elq = EloquaConnection(COMPANY, USERNAME, PASSWORD)

CRUD actions with Eloqua Assets (Custom Objects, Forms, Emails, Landing Pages)

dog_owner_custom_object = CustomObject()
dog_owner_custom_object.raw_data = {
    "name":        "TEST_Dog_Owner",
    "description": "Testing Custom Object for dog owners",
    "fields":      [
            "name":        "DogBreed",
            "displayType": "text",
            "dataType":    "text"
            "name":        "StartOfOwnership",
            "displayType": "text",
            "dataType":    "date"
            "name":        "AgeAtStartOfOwnership",
            "displayType": "text",
            "dataType":    "number"
            "name":        "DogColor",
            "displayType": "text",
            "dataType":    "text"
            "name":        "DogName",
            "displayType": "text",
            "dataType":    "text"

Generate Usable Models from Custom Objects

Generate model code. Useful for when you have data stored in Eloqua like a database.

object_code = elq.generate_custom_object_code("Dog_Owner_0003", class_name="DogOwner")
print (object_code)


class DogOwner(CustomObjectModel):
    NAME = "Dog_Owner_0003"
    PARENT_ID = "501"
    FIELDS = ["DogName1", "Breed1", "DateOfOwnership1"]
    ID_FIELD_MAP = {
        "123" : "DogName1",
        "124" : "Breed1",
        "125" : "DateOfOwnership1"
    DogName1 = None
    Breed1 = None
    DateOfOwnership1 = None

CRUD actions with Custom Object Data Models

first_dog_owner = elq.get(DogOwner, record_id='1')

all_corgi_dog_owners = elq.get_list(DogOwner, 
        "search" : "Breed1='Corgi'"
) = "New Dog Name"



Variable Paths

The holds all the paths used for interaction with the API. Sometimes, a certain API versions works better than others so this is a place where you can change that.

# Login

# Forms
FORM_CREATE_PATH = "/api/REST/2.0/assets/form"
FORM_DELETE_PATH = "/api/REST/2.0/assets/form/{id}"
FORM_UPDATE_PATH = "/api/REST/2.0/assets/form/{id}"
FORM_GET_PATH = "/api/REST/2.0/assets/form/{id}"
FORM_GET_LIST_PATH = "/api/REST/2.0/assets/forms"

# Custom Objects
CUSTOM_OBJECT_CREATE_PATH = "/api/REST/2.0/assets/customObject"
CUSTOM_OBJECT_DELETE_PATH = "/api/REST/2.0/assets/customObject/{id}"
CUSTOM_OBJECT_UPDATE_PATH = "/api/REST/2.0/assets/customObject/{id}"
CUSTOM_OBJECT_GET_PATH = "/api/REST/2.0/assets/customObject/{id}"
CUSTOM_OBJECT_GET_LIST_PATH = "/api/REST/2.0/assets/customObjects"


To perform testing, it is preferable to use your sandbox instance.

  1. Create a eloqua/test/ file. An outline is provided in
  2. Run eloqua/test/ unittests


  • Python 3

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eloqua-lib-0.0.1.tar.gz (10.2 kB view hashes)

Uploaded source

Built Distribution

eloqua_lib-0.0.1-py3-none-any.whl (12.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page