All REST Endpoints
Application/1.0/Accounts
An Oracle Eloqua Account provides group contact information.
Learn more about accounts.
- Create an account
- Method: postPath:
/api/REST/1.0/data/account
- Delete an account
- Method: deletePath:
/api/REST/1.0/data/account/{id}
- Retrieve a list of accounts
- Method: getPath:
/api/REST/1.0/data/accounts
- Retrieve an account
- Method: getPath:
/api/REST/1.0/data/account/{id}
- Update an account
- Method: putPath:
/api/REST/1.0/data/account/{id}
Application/1.0/Activities
Activities are tracked for individual contacts.
- Retrieve a list of activities
- Method: getPath:
/api/REST/1.0/data/activities/contact/{id}
Application/1.0/Contact fields
Contact fields are the fields associated with a specific contact asset.
Learn more about contact fields.
- Create a contact field
- Method: postPath:
/api/REST/1.0/assets/contact/field
- Delete a contact field
- Method: deletePath:
/api/REST/1.0/assets/contact/field/{id}
- Retrieve a contact field
- Method: getPath:
/api/REST/1.0/assets/contact/field/{id}
- Retrieve a list of contact fields
- Method: getPath:
/api/REST/1.0/assets/contact/fields
- Update a contact field
- Method: putPath:
/api/REST/1.0/assets/contact/field/{id}
Application/1.0/Contact list
Customized lists of contacts.
- Create a contact list
- Method: postPath:
/api/REST/1.0/assets/contact/list
- Delete a contact list
- Method: deletePath:
/api/REST/1.0/assets/contact/list/{id}
- Retrieve a contact list
- Method: getPath:
/api/REST/1.0/assets/contact/list/{id}
- Retrieve a list of contact lists
- Method: getPath:
/api/REST/1.0/assets/contact/lists
- Update a contact list
- Method: putPath:
/api/REST/1.0/assets/contact/list/{id}
Application/1.0/Contact segments
Segments API endpoints.
Learn more about segments.
- Create a contact segment
- Method: postPath:
/api/REST/1.0/assets/contact/segment
- Delete a contact segment
- Method: deletePath:
/api/REST/1.0/assets/contact/segment/{id}
- Retrieve a contact segment
- Method: getPath:
/api/REST/1.0/assets/contact/segment/{id}
- Retrieve a list of contact segments
- Method: getPath:
/api/REST/1.0/assets/contact/segments
- Update a contact segment
- Method: putPath:
/api/REST/1.0/assets/contact/segment/{id}
Application/1.0/Contacts
A contact is a data entity that contains the explicit data around an individual person in the database.
Learn more about contacts.
- Create a contact
- Method: postPath:
/api/REST/1.0/data/contact
- Delete a contact
- Method: deletePath:
/api/REST/1.0/data/contact/{id}
- Retrieve a contact
- Method: getPath:
/api/REST/1.0/data/contact/{id}
- Retrieve a list of contacts
- Method: getPath:
/api/REST/1.0/data/contacts
- Update a contact
- Method: putPath:
/api/REST/1.0/data/contact/{id}
Application/1.0/Content sections
Content sections allow you to create shared content to use inside assets such as emails and landing pages.
Learn more about shared content.
- Create a content section
- Method: postPath:
/api/REST/1.0/assets/contentSection
- Delete a content section
- Method: deletePath:
/api/REST/1.0/assets/contentSection/{id}
- Retrieve a content section
- Method: getPath:
/api/REST/1.0/assets/contentSection/{id}
- Retrieve a list of content sections
- Method: getPath:
/api/REST/1.0/assets/contentSections
- Update a content section
- Method: putPath:
/api/REST/1.0/assets/contentSection/{id}
Application/1.0/Custom object data
Custom object data are the records of custom object instances.
Learn more about custom objects.
- Create custom object data
- Method: postPath:
/api/REST/1.0/data/customObject/{id}
- Retrieve a list of custom object data
- Method: getPath:
/api/REST/1.0/data/customObject/{id}
Application/1.0/Custom objects
Custom objects are a complement to the standard Data Entities (i.e. Contacts, Companies). Essentially, custom objects are used for two main functions: linking directly to a Contact and performing actions based on information collected without duplication.
Learn more about custom objects.
- Create a custom object
- Method: postPath:
/api/REST/1.0/assets/customObject
- Delete a custom object
- Method: deletePath:
/api/REST/1.0/assets/customObject/{id}
- Retrieve a custom object
- Method: getPath:
/api/REST/1.0/assets/customObject/{id}
- Retrieve a list of custom objects
- Method: getPath:
/api/REST/1.0/assets/customObjects
- Update a custom object
- Method: putPath:
/api/REST/1.0/assets/customObject/{id}
Application/1.0/Email folders
Email folders organize your email assets.
Learn more about emails.
- Create an email folder
- Method: postPath:
/api/REST/1.0/assets/email/folder
- Delete an email folder
- Method: deletePath:
/api/REST/1.0/assets/email/folder/{id}
- Retrieve a list of email folders
- Method: getPath:
/api/REST/1.0/assets/email/folders
- Retrieve an email folder
- Method: getPath:
/api/REST/1.0/assets/email/folder/{id}
- Update an email folder
- Method: putPath:
/api/REST/1.0/assets/email/folder/{id}
Application/1.0/Email footers
Email footers are used to customize the look and feel of the bottom of your email.
Learn more about email footers.
- Create an email footer
- Method: postPath:
/api/REST/1.0/assets/email/footer
- Delete an email footer
- Method: deletePath:
/api/REST/1.0/assets/email/footer/{id}
- Retrieve a list of email footers
- Method: getPath:
/api/REST/1.0/assets/email/footers
- Retrieve an email footer
- Method: getPath:
/api/REST/1.0/assets/email/footer/{id}
- Update an email footer
- Method: putPath:
/api/REST/1.0/assets/email/footer/{id}
Application/1.0/Email groups
Email Groups are used to control default settings for similar types of emails. For instance, you can set the default header, footer, subscription landing page, and unsubscribe landing page for a set of email newsletters. Then your contacts can subscribe or unsubscribe at the group level to simplify subscription management. As an administrator, you can add or delete groups as required to control email subscriptions.
Learn more about email groups.
- Create an email group
- Method: postPath:
/api/REST/1.0/assets/email/group
- Delete an email group
- Method: deletePath:
/api/REST/1.0/assets/email/group/{id}
- Retrieve a list of email groups
- Method: getPath:
/api/REST/1.0/assets/email/groups
- Retrieve an email group
- Method: getPath:
/api/REST/1.0/assets/email/group/{id}
- Update an email group
- Method: putPath:
/api/REST/1.0/assets/email/group/{id}
Application/1.0/Email headers
Email headers are used to customize the look and feel of the top of your email. Headers can be used in your emails for branding purposes (your company's logo), to provide links to other (external) resources, or to display the link for a contact to view the email in a browser. Email headers are automatically added to your email after selecting and saving the email group to which it belongs, but you can also select a different header on a per-email basis from the email header chooser.
Learn more about email headers.
- Create an email header
- Method: postPath:
/api/REST/1.0/assets/email/header
- Delete an email header
- Method: deletePath:
/api/REST/1.0/assets/email/header/{id}
- Retrieve a list of email headers
- Method: getPath:
/api/REST/1.0/assets/email/headers
- Retrieve an email header
- Method: getPath:
/api/REST/1.0/assets/email/header/{id}
- Update an email header
- Method: putPath:
/api/REST/1.0/assets/email/header/{id}
Application/1.0/Emails
Despite vast innovations and improvements to other channels of communication with prospects, emails are still central to many marketing campaigns. You can reach a large number of existing and potential customers efficiently and cheaply through email messages. Eloqua includes robust email marketing capabilities that you can weave into your marketing campaigns.
Learn more about emails.
- Create an email
- Method: postPath:
/api/REST/1.0/assets/email
- Delete an email
- Method: deletePath:
/api/REST/1.0/assets/email/{id}
- Retrieve a list of emails
- Method: getPath:
/api/REST/1.0/assets/emails
- Retrieve an email
- Method: getPath:
/api/REST/1.0/assets/email/{id}
- Update an email
- Method: putPath:
/api/REST/1.0/assets/email/{id}
Application/1.0/Form data
Form data are the submissions for a form.
Learn more about forms.
- Create form data for a single form
- Method: postPath:
/api/REST/1.0/data/form/{id}
- Retrieve a single form submit job
- Method: getPath:
/api/REST/1.0/data/form/{formId}/formData/{formSubmitJobId}
- Retrieve all form submit jobs for a single form
- Method: getPath:
/api/REST/1.0/data/form/{formId}/formData
- Retrieve processed form data for a single form
- Method: getPath:
/api/REST/1.0/data/form/{id}
Application/1.0/Forms
Form data are the submissions for a form.
Learn more about Forms.
- Create a form
- Method: postPath:
/api/REST/1.0/assets/form
- Delete a form
- Method: deletePath:
/api/REST/1.0/assets/form/{id}
- Retrieve a form
- Method: getPath:
/api/REST/1.0/assets/form/{id}
- Retrieve a list of forms
- Method: getPath:
/api/REST/1.0/assets/forms
- Update a form
- Method: putPath:
/api/REST/1.0/assets/form/{id}
Application/1.0/Images
Image assets to be used in places such as emails or landing pages.
Learn more about images.
- Delete an image
- Method: deletePath:
/api/REST/1.0/assets/image/{id}
- Retrieve a list of images
- Method: getPath:
/api/REST/1.0/assets/images
- Retrieve an image
- Method: getPath:
/api/REST/1.0/assets/image/{id}
- Update an image
- Method: putPath:
/api/REST/1.0/assets/image/{id}
- Upload an image
- Method: postPath:
/api/REST/1.0/assets/image/content
Application/1.0/Landing pages
Landing pages are often the first significant part of a campaign that a contact will see. A contact may be directed to your landing page from a link in an email or from an ad on the web. The landing page provides the contact with more information and options related to the email or ad that brought them there. On the landing page they can be asked to participate in the campaign by reviewing detailed information, submitting a form, or clicking a button to receive additional information etc. The landing page moves prospects through your campaign and gives them a clearer idea about your product and your companies trustworthiness.
Learn more about landing pages.
- Create a landing page
- Method: postPath:
/api/REST/1.0/assets/landingPage
- Delete a landing page
- Method: deletePath:
/api/REST/1.0/assets/landingPage/{id}
- Retrieve a landing page
- Method: getPath:
/api/REST/1.0/assets/landingPage/{id}
- Retrieve a list of landing pages
- Method: getPath:
/api/REST/1.0/assets/landingPages
- Update a landing page
- Method: putPath:
/api/REST/1.0/assets/landingPage/{id}
Application/1.0/Microsites
A microsite is a miniature website, often dedicated to a specific campaign, product, or keyword. The purpose is to give a visitor (whether channeled through your website, social media assets, emails, SMS, or other channels) precise information that they can use to better understand your products and services or to make a buying decision. There are three types of microsites: basic, secure and authenticated. Each landing page you create in Eloqua must have an associated microsite.
Learn more about microsites.
- Create a microsite
- Method: postPath:
/api/REST/1.0/assets/microsite
- Delete a microsite
- Method: deletePath:
/api/REST/1.0/assets/microsite/{id}
- Retrieve a list of microsites
- Method: getPath:
/api/REST/1.0/assets/microsites
- Retrieve a microsite
- Method: getPath:
/api/REST/1.0/assets/microsite/{id}
- Update a microsite
- Method: putPath:
/api/REST/1.0/assets/microsite/{id}
Application/1.0/Option lists
Option lists are usually referred to on the marketers' side as select lists or pick lists.
Learn more about option lists.
- Create an option list
- Method: postPath:
/api/REST/1.0/assets/optionList
- Delete an option list
- Method: deletePath:
/api/REST/1.0/assets/optionList/{id}
- Retrieve a list of option lists
- Method: getPath:
/api/REST/1.0/assets/optionLists
- Retrieve an option list
- Method: getPath:
/api/REST/1.0/assets/optionList/{id}
- Update an option list
- Method: putPath:
/api/REST/1.0/assets/optionList/{id}
Application/1.0/Users
Users API endpoints. The API allows you to modify such things as a user's time preference.
Learn more about user management.
- Retrieve a list of users
- Method: getPath:
/api/REST/1.0/system/users
- Retrieve a user
- Method: getPath:
/api/REST/1.0/system/user/{id}
- Update a user
- Method: putPath:
/api/REST/1.0/system/user/{id}
Application/2.0/Account groups
An Oracle Eloqua Account Group provides the ability to group multiple companies into an Account Group.
Learn more about accounts.
- Create an account group
- Method: postPath:
/api/rest/2.0/assets/account/group
- Delete an account group
- Method: deletePath:
/api/rest/2.0/assets/account/group/{id}
- Retrieve a list of account groups
- Method: getPath:
/api/rest/2.0/assets/account/groups
- Retrieve an account group
- Method: getPath:
/api/rest/2.0/assets/account/group/{id}
- Update an account group
- Method: putPath:
/api/rest/2.0/assets/account/group/{id}
Application/2.0/Accounts
An Oracle Eloqua Account provides group contact information.
Learn more about accounts.
- Retrieve account group membership information for an account
- Method: getPath:
/api/rest/2.0/data/account/{id}/membership
- Retrieve account information
- Method: postPath:
/api/rest/2.0/data/accounts
Application/2.0/Activities
Activities API endpoint.
- Retrieve a list of activities.
- Method: getPath:
/api/rest/2.0/data/activities/contact/{id}/{type}
Application/2.0/Audit logs
The Audit Log API endpoint enables initiating a request for Eloqua audit log exports using the Application API. Specify the type of audit log you want to export within a specified date and time range. If the request is successful, a report will be sent to the email address specified in the request.
- Initiate an audit log export
- Method: postPath:
/api/rest/2.0/data/auditLog/reportExport
Application/2.0/Campaign fields
Campaign fields are the fields associated with a specific campaign asset.
Learn more about campaign fields.
- Create a campaign field.
- Method: postPath:
/api/rest/2.0/assets/campaign/field
- Delete a campaign field.
- Method: deletePath:
/api/rest/2.0/assets/campaign/field/{id}
- Retrieve a campaign field.
- Method: getPath:
/api/rest/2.0/assets/campaign/field/{id}
- Retrieve a list of campaign fields.
- Method: getPath:
/api/rest/2.0/assets/campaign/fields
- Update a Campaign field.
- Method: putPath:
/api/rest/2.0/assets/campaign/field/{id}
Application/2.0/Campaign folders
Campaign folders organize your campaign assets.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/campaign/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/campaign/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/campaign/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/campaign/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/campaign/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/campaign/folder/{id}
Application/2.0/Campaigns
Marketing campaigns are at the center of the Eloqua application, campaigns are comprised of different elements (such as segments, emails, landing pages, etc.) that are used to perform a variety of functions. You can combine the different elements in a number of ways to customize your campaign flow.
Learn more about campaigns.
- Activate a campaign
- Method: postPath:
/api/rest/2.0/assets/campaign/active/{id}
- Create a campaign
- Method: postPath:
/api/rest/2.0/assets/campaign
- Deactivate a campaign
- Method: postPath:
/api/rest/2.0/assets/campaign/draft/{id}
- Delete a campaign
- Method: deletePath:
/api/rest/2.0/assets/campaign/{id}
- Retrieve a campaign
- Method: getPath:
/api/rest/2.0/assets/campaign/{id}
- Retrieve a list of campaigns
- Method: getPath:
/api/rest/2.0/assets/campaigns
- Update a campaign
- Method: putPath:
/api/rest/2.0/assets/campaign/{id}
Application/2.0/Contact segments
Contact segments are groups of contacts generated based on filter criteria and contact lists.
Learn more about Segments.
- Create a contact segment
- Method: postPath:
/api/rest/2.0/assets/contact/segment
- Create a copy of a contact segment
- Method: postPath:
/api/rest/2.0/assets/contact/segment/{id}/copy
- Delete a contact segment
- Method: deletePath:
/api/rest/2.0/assets/contact/segment/{id}
- Retrieve a contact segment
- Method: getPath:
/api/rest/2.0/assets/contact/segment/{id}
- Retrieve a list of contact segments
- Method: getPath:
/api/rest/2.0/assets/contact/segments
- Update a contact segment
- Method: putPath:
/api/rest/2.0/assets/contact/segment/{id}
Application/2.0/Contacts
A contact is a data entity that contains the explicit data around an individual person in the database.
Learn more about contacts.
- Retrieve contact information
- Method: postPath:
/api/rest/2.0/data/contacts
- Retrieve contact list membership information for a contact
- Method: getPath:
/api/rest/2.0/data/contact/{id}/membership
- Retrieves a contact
- Method: getPath:
/api/rest/2.0/data/contact/{id}
- Update a contact
- Method: putPath:
/api/rest/2.0/data/contact/{id}
Application/2.0/Countries
Countries API endpoints.
- Retrieve a list of countries
- Method: getPath:
/api/rest/2.0/system/countries
Application/2.0/Custom object data
Custom object data are the records of custom object instances.
Learn more about custom objects.
- Create custom object data
- Method: postPath:
/api/rest/2.0/data/customObject/{parentId}/instance
- Delete custom object data
- Method: deletePath:
/api/rest/2.0/data/customObject/{parentId}/instance/{id}
- Retrieve a list of custom object data
- Method: getPath:
/api/rest/2.0/data/customObject/{parentId}/instances
- Retrieve custom object data
- Method: getPath:
/api/rest/2.0/data/customObject/{parentId}/instance/{id}
- Update custom object data
- Method: putPath:
/api/rest/2.0/data/customObject/{parentId}/instance/{id}
Application/2.0/Custom objects
Custom objects are a complement to the standard Data Entities (i.e. Contacts, Companies). Essentially, custom objects are used for two main functions: linking directly to a Contact and performing actions based on information collected without duplication.
Learn more about custom objects.
- Create a custom object
- Method: postPath:
/api/rest/2.0/assets/customObject
- Delete a custom object
- Method: deletePath:
/api/rest/2.0/assets/customObject/{id}
- Retrieve a custom object
- Method: getPath:
/api/rest/2.0/assets/customObject/{id}
- Retrieve a list of custom objects
- Method: getPath:
/api/rest/2.0/assets/customObjects
- Update a custom object
- Method: putPath:
/api/rest/2.0/assets/customObject/{id}
Application/2.0/Dedupe Rules
Dedupe Rule endpoints
- Get single Dedupe Rule or Match Rule
- Method: getPath:
/api/rest/2.0/assets/dedupeRule/{ruleId}
- Get single Dedupe Rule or Match Rule Handler Set
- Method: getPath:
/api/rest/2.0/assets/dedupeRule/{ruleId}/handlerSet/{id}
- Get the Dedupe Rule or Match Rule Handler Sets
- Method: getPath:
/api/rest/2.0/assets/dedupeRule/{ruleId}/handlerSets
- Search for Dedupe Rules and Match Rules by Name
- Method: getPath:
/api/rest/2.0/assets/dedupeRules
Application/2.0/Email deployment
The email deployment API is used to send and retrieve email deployments. There are two methods for creating and sending email deployments: to a single contact, or to a low volume of contacts (up to 100 contacts).
Learn more about emails.
- Create and send an email deployment
- Method: postPath:
/api/rest/2.0/assets/email/deployment
- Retrieve an email deployment
- Method: getPath:
/api/rest/2.0/assets/email/deployment/{id}
Application/2.0/Email folders
Email folders organize your email assets.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/email/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/email/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/email/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/email/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/email/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/email/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/email/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/email/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/email/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/email/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/email/folder/{id}
Application/2.0/Emails
Emails API Endpoints.
Learn more about emails. Creating and updating emails with the type
ResponsiveHtmlContent
is not supported. If you use these endpoints with this email type, we cannot guarantee your email will be responsive.- Archive an email
- Method: postPath:
/api/rest/2.0/assets/email/{id}/archive
- Create an email
- Method: postPath:
/api/rest/2.0/assets/email
- Delete an email
- Method: deletePath:
/api/rest/2.0/assets/email/{id}
- Retrieve a list of emails
- Method: getPath:
/api/rest/2.0/assets/emails
- Retrieve an email
- Method: getPath:
/api/rest/2.0/assets/email/{id}
- Unarchive an email
- Method: postPath:
/api/rest/2.0/assets/email/{id}/unarchive
- Update an email
- Method: putPath:
/api/rest/2.0/assets/email/{id}
Application/2.0/Event registrants
The event registration API is used to manage event registrants.
Learn more about Event Management.
- Create an event registrant
- Method: postPath:
/api/rest/2.0/data/eventRegistration/{parentId}/instance
- Delete an event registrant
- Method: deletePath:
/api/rest/2.0/data/eventRegistration/{parentId}/instance/{id}
- Retrieve a list of event registrants
- Method: getPath:
/api/rest/2.0/data/eventRegistration/{parentId}/instances
- Retrieve an event registrant
- Method: getPath:
/api/rest/2.0/data/eventRegistration/{parentId}/instance/{id}
- Update an event registrant
- Method: putPath:
/api/rest/2.0/data/eventRegistration/{parentId}/instance/{id}
Application/2.0/Events
The events API is used to manage events.
Learn more about Event Management.
- Create an event
- Method: postPath:
/api/rest/2.0/assets/eventRegistration
- Delete an event
- Method: deletePath:
/api/rest/2.0/assets/eventRegistration/{id}
- Retrieve a list of events
- Method: getPath:
/api/rest/2.0/assets/eventRegistrations
- Retrieve an event
- Method: getPath:
/api/rest/2.0/assets/eventRegistration/{id}
- Update an event
- Method: putPath:
/api/rest/2.0/assets/eventRegistration/{id}
Application/2.0/External activities
External activities are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.
External asset types is the 'umbrella' (top-level) classification for something that your contacts or prospects are performing, for example, a Tradeshow.
Learn more about external assets.
- Create an external activity
- Method: postPath:
/api/rest/2.0/data/activity
- Retrieve an external activity
- Method: getPath:
/api/rest/2.0/data/activity/{id}
Application/2.0/External asset types
External activities are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.
External asset types is the 'umbrella' (top-level) classification for something that your contacts or prospects are performing, for example, a Tradeshow.
Learn more about external assets.
- Create an external asset type
- Method: postPath:
/api/rest/2.0/assets/external/type
- Delete an external asset type
- Method: deletePath:
/api/rest/2.0/assets/external/type/{id}
- Retrieve a list of external asset types
- Method: getPath:
/api/rest/2.0/assets/external/types
- Retrieve an external asset type
- Method: getPath:
/api/rest/2.0/assets/external/type/{id}
- Update an external asset type
- Method: putPath:
/api/rest/2.0/assets/external/type/{id}
Application/2.0/External assets
External assets are non-Eloqua (that is, offline) activities performed by your contacts or prospects. These assets can be imported for use in Eloqua campaign reporting.
Learn more about external assets.
- Create an external asset
- Method: postPath:
/api/rest/2.0/assets/external
- Delete an external asset
- Method: deletePath:
/api/rest/2.0/assets/external/{id}
- Retrieve a list of external assets
- Method: getPath:
/api/rest/2.0/assets/externals
- Retrieve an external asset
- Method: getPath:
/api/rest/2.0/assets/external/{id}
- Update an external asset
- Method: putPath:
/api/rest/2.0/assets/external/{id}
Application/2.0/Form data
Form data are the submissions for a form.
Learn more about Forms.
- Create form data for a single form
- Method: postPath:
/api/rest/2.0/data/form/{id}
- Create form data in batch for a single form
- Method: postPath:
/api/rest/2.0/data/form/{id}/batch
- Delete form data
- Method: deletePath:
/api/rest/2.0/data/form/{id}/datarow/{rowId}
- Retrieve a single form submit job
- Method: getPath:
/api/rest/2.0/data/form/{formId}/formData/{formSubmitJobId}
- Retrieve all form submit jobs for a single form
- Method: getPath:
/api/rest/2.0/data/form/{formId}/formData
- Retrieve all spam form submit jobs for a single form
- Method: getPath:
/api/rest/2.0/data/form/{formId}/formSpamData
- Retrieve batch form submission details by batchCorrelationId
- Method: getPath:
/api/rest/2.0/data/form/{formId}/batchCorrelation/formData/{batchCorrelationId}
- Retrieve batch form submission details by batchId
- Method: getPath:
/api/rest/2.0/data/form/{formId}/batch/formData/{batchId}
- Retrieve processed form data for a single form
- Method: getPath:
/api/rest/2.0/data/form/{id}
Application/2.0/Form folders
Form folders organize your form assets.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/form/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/form/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/form/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/form/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/form/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/form/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/form/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/form/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/form/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/form/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/form/folder/{id}
Application/2.0/Forms
Forms API endpoints.
Learn more about Forms.
- Archive a form
- Method: postPath:
/api/rest/2.0/assets/form/{id}/archive
- Create a form
- Method: postPath:
/api/rest/2.0/assets/form
- Delete a form
- Method: deletePath:
/api/rest/2.0/assets/form/{id}
- Partially update a form
- Method: patchPath:
/api/rest/2.0/assets/form/{id}
- Retrieve a form
- Method: getPath:
/api/rest/2.0/assets/form/{id}
- Retrieve a list of forms
- Method: getPath:
/api/rest/2.0/assets/forms
- Unarchive a form
- Method: postPath:
/api/rest/2.0/assets/form/{id}/unarchive
- Update a form
- Method: putPath:
/api/rest/2.0/assets/form/{id}
Application/2.0/Hyperlink folders
Hyperlink folders organize your hyperlinks.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/hyperlink/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/hyperlink/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/hyperlink/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/hyperlink/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/hyperlink/folder/{id}
Application/2.0/Image folders
Image folders organize your image assets.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/image/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/image/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/image/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/image/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/image/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/image/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/image/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/image/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/image/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/image/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/image/folder/{id}
Application/2.0/Landing pages
Landing Pages API endpoints.
Learn more about landing pages.
- Create a landing page
- Method: postPath:
/api/rest/2.0/assets/landingPage
- Delete a landing page
- Method: deletePath:
/api/rest/2.0/assets/landingPage/{id}
- Retrieve a landing page
- Method: getPath:
/api/rest/2.0/assets/landingPage/{id}
- Retrieve a list of landing pages
- Method: getPath:
/api/rest/2.0/assets/landingPages
- Update a landing page
- Method: putPath:
/api/rest/2.0/assets/landingPage/{id}
Application/2.0/Lookup tables
Lookup table endpoints
- Add lookup table Entry for an existing lookup table
- Method: postPath:
/api/rest/2.0/assets/lookupTable/{id}/lookupTableEntry
- Delete Lookup Table Entry by ID
- Method: deletePath:
/api/rest/2.0/assets/lookupTable/{lookupTableId}/lookupTableEntry/{elementId}
- Retrieve a lookup table.
- Method: getPath:
/api/rest/2.0/assets/lookupTable/{id}
- Search for a Lookup table by Name field
- Method: getPath:
/api/rest/2.0/assets/lookupTables
- Search for Lookup table Entries by Lookup or Replacement field
- Method: getPath:
/api/rest/2.0/assets/lookupTable/{id}/lookupTableEntries
- Update existing Lookup Table Entry
- Method: putPath:
/api/rest/2.0/assets/lookupTable/{lookupTableId}/lookupTableEntry/{elementId}
Application/2.0/Programs
Programs API endpoints.
Learn more about Programs.
- Activate a program
- Method: postPath:
/api/rest/2.0/assets/program/active/{id}
- Create a program
- Method: postPath:
/api/rest/2.0/assets/program
- Deactivate a program
- Method: postPath:
/api/rest/2.0/assets/program/draft/{id}
- Delete a program
- Method: deletePath:
/api/rest/2.0/assets/program/{id}
- Pause a program
- Method: postPath:
/api/rest/2.0/assets/program/pause/{id}
- Retrieve a list of programs
- Method: getPath:
/api/rest/2.0/assets/programs
- Retrieve a program
- Method: getPath:
/api/rest/2.0/assets/program/{id}
- Update a program
- Method: putPath:
/api/rest/2.0/assets/program/{id}
Application/2.0/SMS
SMS API endpoints.
- Create an SMS
- Method: postPath:
/api/rest/2.0/assets/sms
- Delete an SMS
- Method: deletePath:
/api/rest/2.0/assets/sms/{id}
- Retrieve a list of SMS
- Method: getPath:
/api/rest/2.0/assets/sms
- Retrieve an SMS
- Method: getPath:
/api/rest/2.0/assets/sms/{id}
- Update an SMS
- Method: putPath:
/api/rest/2.0/assets/sms/{id}
Application/2.0/SMS codes
SMS sender codes API endpoints.
- Retrieve a list of sender codes
- Method: getPath:
/api/rest/2.0/assets/sms/senderCodes
Application/2.0/SMS folders
SMS folders organize your SMS assets.
- Add content to a folder
- Method: patchPath:
/api/rest/2.0/assets/sms/folder/{id}/contents
- Create a folder
- Method: postPath:
/api/rest/2.0/assets/sms/folder
- Delete a folder
- Method: deletePath:
/api/rest/2.0/assets/sms/folder/{id}
- Retrieve a folder
- Method: getPath:
/api/rest/2.0/assets/sms/folder/{id}
- Retrieve a list of folder contents
- Method: getPath:
/api/rest/2.0/assets/sms/folder/{id}/contents
- Retrieve a list of folder contents in the root folder
- Method: getPath:
/api/rest/2.0/assets/sms/folder/root/contents
- Retrieve a list of folders
- Method: getPath:
/api/rest/2.0/assets/sms/folders
- Retrieve a list of subfolders
- Method: getPath:
/api/rest/2.0/assets/sms/folder/{id}/folders
- Retrieve a list of subfolders in the root folder
- Method: getPath:
/api/rest/2.0/assets/sms/folder/root/folders
- Retrieve the root folder
- Method: getPath:
/api/rest/2.0/assets/sms/folder/root
- Update a folder
- Method: putPath:
/api/rest/2.0/assets/sms/folder/{id}
Application/2.0/SMS invalid keyword messages
SMS invalid keyword response message API endpoints.
- Create a message
- Method: postPath:
/api/rest/2.0/assets/sms/invalidResponseMessage
- Delete a message
- Method: deletePath:
/api/rest/2.0/assets/sms/invalidResponseMessage/{id}
- Retrieve a list of message
- Method: getPath:
/api/rest/2.0/assets/sms/invalidResponseMessages
- Retrieve a message
- Method: getPath:
/api/rest/2.0/assets/sms/invalidResponseMessage/{id}
- Update a message
- Method: putPath:
/api/rest/2.0/assets/sms/invalidResponseMessage/{id}
Application/2.0/SMS keywords
SMS keywords API endpoints.
- Create a Keyword
- Method: postPath:
/api/rest/2.0/assets/sms/keyword
- Delete a keyword
- Method: deletePath:
/api/rest/2.0/assets/sms/keyword/{id}
- Retrieve a keyword
- Method: getPath:
/api/rest/2.0/assets/sms/keyword/{id}
- Retrieve a list of keywords
- Method: getPath:
/api/rest/2.0/assets/sms/keywords
Application/2.0/SMS subscription
The SMS subscription API is used to manage phone number consent.
- Retrieve a list of subscription
- Method: postPath:
/api/rest/2.0/data/sms/subscription
- Update a subscription
- Method: putPath:
/api/rest/2.0/data/sms/subscription
Application/2.0/Security groups
Security group API endpoints.
- Add or remove users from a security group
- Method: patchPath:
/api/rest/2.0/system/security/group/{id}/users
- Create a security group
- Method: postPath:
/api/rest/2.0/system/security/group
- Delete a security group
- Method: deletePath:
/api/rest/2.0/system/security/group/{id}
- Retrieve a list of users
- Method: getPath:
/api/rest/2.0/system/security/group/{id}/users
- Retrieve a security group
- Method: getPath:
/api/rest/2.0/system/security/group/{id}
- Retrieve security groups
- Method: getPath:
/api/rest/2.0/system/security/groups
- Update a security group
- Method: putPath:
/api/rest/2.0/system/security/group/{id}
Application/2.0/Signature Rule Mappings
Signature rule mappings API endpoints.
- Create signature rule mappings
- Method: postPath:
/api/rest/2.0/assets/email/signature/rule/{ruleId}/mappings
- Delete signature rule mappings
- Method: deletePath:
/api/rest/2.0/assets/email/signature/rule/{ruleId}/mappings
- Retrieve a list of signature rule mappings
- Method: getPath:
/api/rest/2.0/assets/email/signature/rule/{ruleId}/mappings
- Update signature rule mappings
- Method: putPath:
/api/rest/2.0/assets/email/signature/rule/{ruleId}/mappings
Application/2.0/Signature Rules
Signature rules API endpoints.
- Create a signature rule
- Method: postPath:
/api/rest/2.0/assets/email/signature/rule
- Delete a signature rule
- Method: deletePath:
/api/rest/2.0/assets/email/signature/rule/{id}
- Retrieve a list of signature rules
- Method: getPath:
/api/rest/2.0/assets/email/signature/rules
- Retrieve a signature rule
- Method: getPath:
/api/rest/2.0/assets/email/signature/rule/{id}
- Update a signature rule
- Method: putPath:
/api/rest/2.0/assets/email/signature/rule/{id}
Application/2.0/Users
Users API endpoints.
- Create a user
- Method: postPath:
/api/rest/2.0/system/user
- Delete a user
- Method: deletePath:
/api/rest/2.0/system/user/{id}
- Enable or disable a user
- Method: putPath:
/api/rest/2.0/system/user/{id}/enabled
- Retrieve a list of users
- Method: getPath:
/api/rest/2.0/system/users
- Retrieve a user
- Method: getPath:
/api/rest/2.0/system/user/{id}
- Retrieve the current user
- Method: getPath:
/api/rest/2.0/system/user/current
- Update a user
- Method: putPath:
/api/rest/2.0/system/user/{id}
- Update a user's password
- Method: putPath:
/api/rest/2.0/system/user/{id}/password
Application/2.0/Visitor profile fields
A visitor profile field are the fields associated to a website visitor. Learn more about Visitor Profile Fields.
- Retrieve a list of visitor profile fields
- Method: getPath:
/api/rest/2.0/assets/visitor/fields
Application/2.0/Visitors
A visitor is a data entity that represents a unique cookie. The tracked activity data from that cookie is associated with the Visitor. There can be multiple visitors linked to a single contact.
- Retrieve visitor data
- Method: getPath:
/api/rest/2.0/data/visitors
- Retrieve visitor data by visitor GUID
- Method: postPath:
/api/rest/2.0/data/visitors
Bulk/2.0/accounts
The operations from the Bulk/2.0/accounts category.
- Create an account export definition
- Method: postPath:
/api/bulk/2.0/accounts/exports
- Create an account import definition
- Method: postPath:
/api/bulk/2.0/accounts/imports
- Create an account sync action definition
- Method: postPath:
/api/bulk/2.0/accounts/syncActions
- Delete an account export definition
- Method: deletePath:
/api/bulk/2.0/accounts/exports/{id}
- Delete an account export definition's data
- Method: deletePath:
/api/bulk/2.0/accounts/exports/{id}/data
- Delete an account import definition
- Method: deletePath:
/api/bulk/2.0/accounts/imports/{id}
- Delete an account import definition's data
- Method: deletePath:
/api/bulk/2.0/accounts/imports/{id}/data
- Delete an account sync action definition
- Method: deletePath:
/api/bulk/2.0/accounts/syncActions/{id}
- Delete sync data for an account sync action definition
- Method: deletePath:
/api/bulk/2.0/accounts/syncActions/{id}/data
- Retrieve a list of account export definitions
- Method: getPath:
/api/bulk/2.0/accounts/exports
- Retrieve a list of account field definitions
- Method: getPath:
/api/bulk/2.0/accounts/fields
- Retrieve a list of account import definitions
- Method: getPath:
/api/bulk/2.0/accounts/imports
- Retrieve a list of account list definitions
- Method: getPath:
/api/bulk/2.0/accounts/lists
- Retrieve a list of account sync action definitions
- Method: getPath:
/api/bulk/2.0/accounts/syncActions
- Retrieve an account export definition
- Method: getPath:
/api/bulk/2.0/accounts/exports/{id}
- Retrieve an account export definition's synced data
- Method: getPath:
/api/bulk/2.0/accounts/exports/{id}/data
- Retrieve an account field definition
- Method: getPath:
/api/bulk/2.0/accounts/fields/{id}
- Retrieve an account import definition
- Method: getPath:
/api/bulk/2.0/accounts/imports/{id}
- Retrieve an account list definition
- Method: getPath:
/api/bulk/2.0/accounts/lists/{id}
- Retrieve an account sync action definition
- Method: getPath:
/api/bulk/2.0/accounts/syncActions/{id}
- Update an account export definition
- Method: putPath:
/api/bulk/2.0/accounts/exports/{id}
- Update an account import definition
- Method: putPath:
/api/bulk/2.0/accounts/imports/{id}
- Update an account sync action definition
- Method: putPath:
/api/bulk/2.0/accounts/syncActions/{id}
- Upload account sync action data
- Method: postPath:
/api/bulk/2.0/accounts/syncActions/{id}/data
- Upload data for a specified account import definition
- Method: postPath:
/api/bulk/2.0/accounts/imports/{id}/data
Bulk/2.0/activities
The operations from the Bulk/2.0/activities category.
- Create an activity export definition
- Method: postPath:
/api/bulk/2.0/activities/exports
- Create an activity import definition
- Method: postPath:
/api/bulk/2.0/activities/imports
- Delete an activity export definition
- Method: deletePath:
/api/bulk/2.0/activities/exports/{id}
- Delete an activity export definition's data
- Method: deletePath:
/api/bulk/2.0/activities/exports/{id}/data
- Delete an activity import definition
- Method: deletePath:
/api/bulk/2.0/activities/imports/{id}
- Delete an activity import definition's data
- Method: deletePath:
/api/bulk/2.0/activities/imports/{id}/data
- Retrieve a list of activity export definitions
- Method: getPath:
/api/bulk/2.0/activities/exports
- Retrieve a list of activity field definitions
- Method: getPath:
/api/bulk/2.0/activities/fields
- Retrieve a list of activity import definitions
- Method: getPath:
/api/bulk/2.0/activities/imports
- Retrieve an activity export definition
- Method: getPath:
/api/bulk/2.0/activities/exports/{id}
- Retrieve an activity export's synced data
- Method: getPath:
/api/bulk/2.0/activities/exports/{id}/data
- Retrieve an activity field definition
- Method: getPath:
/api/bulk/2.0/activities/fields/{id}
- Retrieve an activity import definition
- Method: getPath:
/api/bulk/2.0/activities/imports/{id}
- Update an activity export definition
- Method: putPath:
/api/bulk/2.0/activities/exports/{id}
- Update an activity import definition
- Method: putPath:
/api/bulk/2.0/activities/imports/{id}
- Upload data for a specified activity import definition
- Method: postPath:
/api/bulk/2.0/activities/imports/{id}/data
Bulk/2.0/campaignResponses
The operations from the Bulk/2.0/campaignResponses category.
- Create a campaign response export definition
- Method: postPath:
/api/bulk/2.0/campaignResponses/exports
- Create a campaign response import definition
- Method: postPath:
/api/bulk/2.0/campaignResponses/imports
- Delete a campaign response export definition
- Method: deletePath:
/api/bulk/2.0/campaignResponses/exports/{id}
- Delete a campaign response import definition
- Method: deletePath:
/api/bulk/2.0/campaignResponses/imports/{id}
- Delete the synced data for a campaign response export definition
- Method: deletePath:
/api/bulk/2.0/campaignResponses/exports/{id}/data
- Delete the synced data for a campaign response import definition
- Method: deletePath:
/api/bulk/2.0/campaignResponses/imports/{id}/data
- Retrieve a campaign response export definition
- Method: getPath:
/api/bulk/2.0/campaignResponses/exports/{id}
- Retrieve a campaign response field definition
- Method: getPath:
/api/bulk/2.0/campaignResponses/fields/{id}
- Retrieve a campaign response import definition
- Method: getPath:
/api/bulk/2.0/campaignResponses/imports/{id}
- Retrieve a list of campaign response export definitions
- Method: getPath:
/api/bulk/2.0/campaignResponses/exports
- Retrieve a list of campaign response import definitions
- Method: getPath:
/api/bulk/2.0/campaignResponses/imports
- Retrieve all campaign response fields
- Method: getPath:
/api/bulk/2.0/campaignResponses/fields
- Retrieve the synced data for a campaign response export definition
- Method: getPath:
/api/bulk/2.0/campaignResponses/exports/{id}/data
- Update a campaign response export definition
- Method: putPath:
/api/bulk/2.0/campaignResponses/exports/{id}
- Update a campaign response import definition
- Method: putPath:
/api/bulk/2.0/campaignResponses/imports/{id}
- Upload data for a campaign response import definition
- Method: postPath:
/api/bulk/2.0/campaignResponses/imports/{id}/data
Bulk/2.0/campaigns
The operations from the Bulk/2.0/campaigns category.
- Retrieve a campaign field definition
- Method: getPath:
/api/bulk/2.0/campaigns/fields/{id}
- Retrieve a list of campaign fields
- Method: getPath:
/api/bulk/2.0/campaigns/fields
Bulk/2.0/contacts
The operations from the Bulk/2.0/contacts category.
- Create a contact export definition
- Method: postPath:
/api/bulk/2.0/contacts/exports
- Create a contact import definition
- Method: postPath:
/api/bulk/2.0/contacts/imports
- Create a contact sync action definition
- Method: postPath:
/api/bulk/2.0/contacts/syncActions
- Delete a contact export definition
- Method: deletePath:
/api/bulk/2.0/contacts/exports/{id}
- Delete a contact export definition's data
- Method: deletePath:
/api/bulk/2.0/contacts/exports/{id}/data
- Delete a contact import definition
- Method: deletePath:
/api/bulk/2.0/contacts/imports/{id}
- Delete a contact import definition's data
- Method: deletePath:
/api/bulk/2.0/contacts/imports/{id}/data
- Delete a contact sync action definition
- Method: deletePath:
/api/bulk/2.0/contacts/syncActions/{id}
- Delete sync data for a contact sync action definition
- Method: deletePath:
/api/bulk/2.0/contacts/syncActions/{id}/data
- Retrieve a contact export definition
- Method: getPath:
/api/bulk/2.0/contacts/exports/{id}
- Retrieve a contact export definition's synced data
- Method: getPath:
/api/bulk/2.0/contacts/exports/{id}/data
- Retrieve a contact field definition
- Method: getPath:
/api/bulk/2.0/contacts/fields/{id}
- Retrieve a contact filter
- Method: getPath:
/api/bulk/2.0/contacts/filters/{id}
- Retrieve a contact import definition
- Method: getPath:
/api/bulk/2.0/contacts/imports/{id}
- Retrieve a contact list
- Method: getPath:
/api/bulk/2.0/contacts/lists/{id}
- Retrieve a contact segment
- Method: getPath:
/api/bulk/2.0/contacts/segments/{id}
- Retrieve a contact sync action definition
- Method: getPath:
/api/bulk/2.0/contacts/syncActions/{id}
- Retrieve a lead scoring model
- Method: getPath:
/api/bulk/2.0/contacts/scoring/models/{id}
- Retrieve a list of contact export definitions
- Method: getPath:
/api/bulk/2.0/contacts/exports
- Retrieve a list of contact field definitions
- Method: getPath:
/api/bulk/2.0/contacts/fields
- Retrieve a list of contact filters
- Method: getPath:
/api/bulk/2.0/contacts/filters
- Retrieve a list of contact import definitions
- Method: getPath:
/api/bulk/2.0/contacts/imports
- Retrieve a list of contact lists
- Method: getPath:
/api/bulk/2.0/contacts/lists
- Retrieve a list of contact segments
- Method: getPath:
/api/bulk/2.0/contacts/segments
- Retrieve a list of contact sync action definitions
- Method: getPath:
/api/bulk/2.0/contacts/syncActions
- Retrieve a list of lead scoring models
- Method: getPath:
/api/bulk/2.0/contacts/scoring/models
- Update a contact export definition
- Method: putPath:
/api/bulk/2.0/contacts/exports/{id}
- Update a contact import definition
- Method: putPath:
/api/bulk/2.0/contacts/imports/{id}
- Update a contact sync action definition
- Method: putPath:
/api/bulk/2.0/contacts/syncActions/{id}
- Upload contact sync action data
- Method: postPath:
/api/bulk/2.0/contacts/syncActions/{id}/data
- Upload data for a contact import definition
- Method: postPath:
/api/bulk/2.0/contacts/imports/{id}/data
Bulk/2.0/customObjects
The operations from the Bulk/2.0/customObjects category.
- Create a custom object sync action definition
- Method: postPath:
/api/bulk/2.0/customObjects/{parentId}/syncActions
- Create an export definition for a custom object
- Method: postPath:
/api/bulk/2.0/customObjects/{parentId}/exports
- Create an import definition for a custom object
- Method: postPath:
/api/bulk/2.0/customObjects/{parentId}/imports
- Delete a custom object export definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/exports/{id}
- Delete a custom object import definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/imports/{id}
- Delete a custom object sync action definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
- Delete sync data for a custom object sync action definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data
- Delete synced data for a custom object import definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/imports/{id}/data
- Delete the synced data for a custom object export definition
- Method: deletePath:
/api/bulk/2.0/customObjects/{parentId}/exports/{id}/data
- Retrieve a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}
- Retrieve a custom object field definition
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/fields/{id}
- Retrieve a custom object sync action definition for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
- Retrieve a list of custom objects
- Method: getPath:
/api/bulk/2.0/customObjects
- Retrieve a list of export definitions for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/exports
- Retrieve a list of import definitions for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/imports
- Retrieve a list of sync action definitions for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/syncActions
- Retrieve a list of the fields for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/fields
- Retrieve an import definition for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/imports/{id}
- Retrieve the specified export definition for a custom object
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/exports/{id}
- Retrieve the synced data for a custom object export definition
- Method: getPath:
/api/bulk/2.0/customObjects/{parentId}/exports/{id}/data
- Update a custom object sync action definition
- Method: putPath:
/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
- Update an export definition for a custom object
- Method: putPath:
/api/bulk/2.0/customObjects/{parentId}/exports/{id}
- Update an import definition for a custom object
- Method: putPath:
/api/bulk/2.0/customObjects/{parentId}/imports/{id}
- Upload custom object sync action data
- Method: postPath:
/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data
- Upload data for a custom object import definition
- Method: postPath:
/api/bulk/2.0/customObjects/{parentId}/imports/{id}/data
Bulk/2.0/emailAddresses
The operations from the Bulk/2.0/emailAddresses category.
- Create an email address import definition
- Method: postPath:
/api/bulk/2.0/emailAddresses/imports
- Delete an email address import definition
- Method: deletePath:
/api/bulk/2.0/emailAddresses/imports/{id}
- Delete an email address import definition's synced data
- Method: deletePath:
/api/bulk/2.0/emailAddresses/imports/{id}/data
- Retrieve a list of email address import definitions
- Method: getPath:
/api/bulk/2.0/emailAddresses/imports
- Retrieve an email address import definition
- Method: getPath:
/api/bulk/2.0/emailAddresses/imports/{id}
- Submit data for an email address import
- Method: postPath:
/api/bulk/2.0/emailAddresses/imports/{id}/data
- Update an email address import definition
- Method: putPath:
/api/bulk/2.0/emailAddresses/imports/{id}
Bulk/2.0/emailGroups
The operations from the Bulk/2.0/emailGroups category.
- Retrieve a list of email groups
- Method: getPath:
/api/bulk/2.0/emailGroups
- Retrieve an email group
- Method: getPath:
/api/bulk/2.0/emailGroups/{id}
Bulk/2.0/events
The operations from the Bulk/2.0/events category.
- Create an export definition for an event
- Method: postPath:
/api/bulk/2.0/events/{parentId}/exports
- Create an import definition for an event
- Method: postPath:
/api/bulk/2.0/events/{parentId}/imports
- Delete an export definition for an event
- Method: deletePath:
/api/bulk/2.0/events/{parentId}/exports/{id}
- Delete an import definition for an event
- Method: deletePath:
/api/bulk/2.0/events/{parentId}/imports/{id}
- Delete the synced data for an event export definition
- Method: deletePath:
/api/bulk/2.0/events/{parentId}/exports/{id}/data
- Delete the synced data for an event import definition
- Method: deletePath:
/api/bulk/2.0/events/{parentId}/imports/{id}/data
- Retrieve a list of events
- Method: getPath:
/api/bulk/2.0/events
- Retrieve a list of export definitions for an event
- Method: getPath:
/api/bulk/2.0/events/{id}/exports
- Retrieve a list of import definitions for an event
- Method: getPath:
/api/bulk/2.0/events/{id}/imports
- Retrieve a list of the fields for an event
- Method: getPath:
/api/bulk/2.0/events/{id}/fields
- Retrieve an event
- Method: getPath:
/api/bulk/2.0/events/{id}
- Retrieve an event field definition
- Method: getPath:
/api/bulk/2.0/events/{parentId}/fields/{id}
- Retrieve an export definition for an event
- Method: getPath:
/api/bulk/2.0/events/{parentId}/exports/{id}
- Retrieve an import definition for an event
- Method: getPath:
/api/bulk/2.0/events/{parentId}/imports/{id}
- Retrieve the synced data for an event export definition
- Method: getPath:
/api/bulk/2.0/events/{parentId}/exports/{id}/data
- Update an export definition for an event
- Method: putPath:
/api/bulk/2.0/events/{parentId}/exports/{id}
- Update an import definition for an event
- Method: putPath:
/api/bulk/2.0/events/{parentId}/imports/{id}
- Upload data for an event import definition
- Method: postPath:
/api/bulk/2.0/events/{parentId}/imports/{id}/data
Bulk/2.0/exports
The operations from the Bulk/2.0/exports category.
- Discover the amount of database space your exports are using
- Method: getPath:
/api/bulk/2.0/exports/data
- Retrieve a list of exports
- Method: getPath:
/api/bulk/2.0/exports
Bulk/2.0/imports
The operations from the Bulk/2.0/imports category.
- Discover the amount of database space your imports are using
- Method: getPath:
/api/bulk/2.0/imports/data
- Retrieve a list of import priorities
- Method: getPath:
/api/bulk/2.0/imports/priorities
- Retrieve a list of imports
- Method: getPath:
/api/bulk/2.0/imports
- Retrieve an import priority
- Method: getPath:
/api/bulk/2.0/imports/priorities/{id}
Bulk/2.0/opportunities
The operations from the Bulk/2.0/opportunities category.
- Create an opportunity contact linkage import definition
- Method: postPath:
/api/bulk/2.0/opportunities/contacts/imports
- Create an opportunity import definition
- Method: postPath:
/api/bulk/2.0/opportunities/imports
- Delete an opportunity contact linkage import definition
- Method: deletePath:
/api/bulk/2.0/opportunities/contacts/imports/{id}
- Delete an opportunity import definition
- Method: deletePath:
/api/bulk/2.0/opportunities/imports/{id}
- Delete the synced data for an opportunity contact linkage import definition
- Method: deletePath:
/api/bulk/2.0/opportunities/contacts/imports/{id}/data
- Delete the synced data for an opportunity import definition
- Method: deletePath:
/api/bulk/2.0/opportunities/imports/{id}/data
- Retrieve a list of opportunity contact linkage import definitions
- Method: getPath:
/api/bulk/2.0/opportunities/contacts/imports
- Retrieve a list of opportunity fields
- Method: getPath:
/api/bulk/2.0/opportunities/fields
- Retrieve a list of opportunity import definitions
- Method: getPath:
/api/bulk/2.0/opportunities/imports
- Retrieve an opportunity contact linkage import definition
- Method: getPath:
/api/bulk/2.0/opportunities/contacts/imports/{id}
- Retrieve an opportunity field definition
- Method: getPath:
/api/bulk/2.0/opportunities/fields/{id}
- Retrieve an opportunity import definition
- Method: getPath:
/api/bulk/2.0/opportunities/imports/{id}
- Update an opportunity contact linkage import definition
- Method: putPath:
/api/bulk/2.0/opportunities/contacts/imports/{id}
- Update an opportunity import definition
- Method: putPath:
/api/bulk/2.0/opportunities/imports/{id}
- Upload data for an opportunity contact linkage import definition
- Method: postPath:
/api/bulk/2.0/opportunities/contacts/imports/{id}/data
- Upload data for an opportunity import definition
- Method: postPath:
/api/bulk/2.0/opportunities/imports/{id}/data
Bulk/2.0/phoneNumbers
The operations from the Bulk/2.0/phoneNumbers category.
- Create a phone number import definition
- Method: postPath:
/api/bulk/2.0/phoneNumbers/imports
- Delete a phone number import definition
- Method: deletePath:
/api/bulk/2.0/phoneNumbers/imports/{id}
- Delete an phone number import definition's data
- Method: deletePath:
/api/bulk/2.0/phoneNumbers/imports/{id}/data
- Retrieve a list of phone number import definitions
- Method: getPath:
/api/bulk/2.0/phoneNumbers/imports
- Retrieve a phone number import definition
- Method: getPath:
/api/bulk/2.0/phoneNumbers/imports/{id}
- Update an phone number import definition
- Method: putPath:
/api/bulk/2.0/phoneNumbers/imports/{id}
- Upload data for a specified phone number import definition
- Method: postPath:
/api/bulk/2.0/phoneNumbers/imports/{id}/data
Bulk/2.0/syncActions
The operations from the Bulk/2.0/syncActions category.
- Retrieve a list of sync action definitions
- Method: getPath:
/api/bulk/2.0/syncActions
Bulk/2.0/syncs
The operations from the Bulk/2.0/syncs category.
- Create an import or export sync
- Method: postPath:
/api/bulk/2.0/syncs
- Delete sync data
- Method: deletePath:
/api/bulk/2.0/syncs/{id}/data
- Retrieve a list of syncs
- Method: getPath:
/api/bulk/2.0/syncs
- Retrieve a sync
- Method: getPath:
/api/bulk/2.0/syncs/{id}
- Retrieve a sync's logs
- Method: getPath:
/api/bulk/2.0/syncs/{id}/logs
- Retrieve an export sync's data
- Method: getPath:
/api/bulk/2.0/syncs/{id}/data
- Retrieve import sync failure data
- Method: getPath:
/api/bulk/2.0/syncs/{id}/rejects
Reporting/AccountActivity/1.0/Account
The operations from the Reporting/AccountActivity/1.0/Account category.
- Get a single Account
- Method: getPath:
/API/OData/AccountActivity/1/Account/{key}
- Get Account ID from Account name
- Method: getPath:
/API/OData/AccountActivity/1/Account/AccountIDByAccountName(AccountName='{AccountName}')
- Get all Accounts
- Method: getPath:
/API/OData/AccountActivity/1/Account
- Get Company Name from Account ID
- Method: getPath:
/API/OData/AccountActivity/1/Account/AccountIDByCompanyName(CompanyName='{CompanyName}')
Reporting/AccountActivity/1.0/AccountEngagement
The operations from the Reporting/AccountActivity/1.0/AccountEngagement category.
- Get a single Account Engagement
- Method: getPath:
/API/OData/AccountActivity/1/AccountEngagement/{key}
- Get all Account Engagements
- Method: getPath:
/API/OData/AccountActivity/1/AccountEngagement
Reporting/ActivityDetails/1.0/Campaign
The operations from the Reporting/ActivityDetails/1.0/Campaign category.
- Get a single Campaign
- Method: getPath:
/API/OData/ActivityDetails/1/Campaign/{key}
- Get all Campaigns
- Method: getPath:
/API/OData/ActivityDetails/1/Campaign
Reporting/ActivityDetails/1.0/CampaignResponse
The operations from the Reporting/ActivityDetails/1.0/CampaignResponse category.
- Get a single Campaign Response
- Method: getPath:
/API/OData/ActivityDetails/1/CampaignResponse/{key}
- Get all Campaign Responses
- Method: getPath:
/API/OData/ActivityDetails/1/CampaignResponse
Reporting/ActivityDetails/1.0/Contact
The operations from the Reporting/ActivityDetails/1.0/Contact category.
- Get a single Contact, Label access control is respected
- Method: getPath:
/API/OData/ActivityDetails/1/Contact/{key}
- Get all Contacts, Label access control is respected
- Method: getPath:
/API/OData/ActivityDetails/1/Contact
Reporting/ActivityDetails/1.0/ContactIntegrationFields
The operations from the Reporting/ActivityDetails/1.0/ContactIntegrationFields category.
- Get Contact Integration Fields for a contact
- Method: getPath:
/API/OData/ActivityDetails/1/ContactIntegrationFields/{key}
- Get Contact Integration Fields for all contacts
- Method: getPath:
/API/OData/ActivityDetails/1/ContactIntegrationFields
Reporting/ActivityDetails/1.0/Device
The operations from the Reporting/ActivityDetails/1.0/Device category.
- Get a single Device
- Method: getPath:
/API/OData/ActivityDetails/1/Device/{key}
- Get all Devices
- Method: getPath:
/API/OData/ActivityDetails/1/Device
Reporting/ActivityDetails/1.0/EloquaLinkedAccount
The operations from the Reporting/ActivityDetails/1.0/EloquaLinkedAccount category.
- Get Eloqua Linked Accounts
- Method: getPath:
/API/OData/ActivityDetails/1/EloquaLinkedAccount
- Get the Eloqua Linked Account by EloquaLinkedAccountID
- Method: getPath:
/API/OData/ActivityDetails/1/EloquaLinkedAccount/{key}
Reporting/ActivityDetails/1.0/EmailAsset
The operations from the Reporting/ActivityDetails/1.0/EmailAsset category.
- Get a single Email Asset
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAsset/{key}
- Get all Email Assets
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAsset
Reporting/ActivityDetails/1.0/EmailAutoClick
The operations from the Reporting/ActivityDetails/1.0/EmailAutoClick category.
- Get a single Email Auto Click
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAutoClick/{key}
- Get all Email Auto Clicks
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAutoClick
Reporting/ActivityDetails/1.0/EmailAutoOpen
The operations from the Reporting/ActivityDetails/1.0/EmailAutoOpen category.
- Get a single Email Auto Open
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAutoOpen/{key}
- Get all Email Auto Opens
- Method: getPath:
/API/OData/ActivityDetails/1/EmailAutoOpen
Reporting/ActivityDetails/1.0/EmailBounceback
The operations from the Reporting/ActivityDetails/1.0/EmailBounceback category.
- Get a single Email Bounceback
- Method: getPath:
/API/OData/ActivityDetails/1/EmailBounceback/{key}
- Get all Email Bouncebacks
- Method: getPath:
/API/OData/ActivityDetails/1/EmailBounceback
Reporting/ActivityDetails/1.0/EmailClickthrough
The operations from the Reporting/ActivityDetails/1.0/EmailClickthrough category.
- Get a single Email Clickthrough
- Method: getPath:
/API/OData/ActivityDetails/1/EmailClickthrough/{key}
- Get all Email Clickthroughs
- Method: getPath:
/API/OData/ActivityDetails/1/EmailClickthrough
Reporting/ActivityDetails/1.0/EmailGroup
The operations from the Reporting/ActivityDetails/1.0/EmailGroup category.
- Get a single Email Group
- Method: getPath:
/API/OData/ActivityDetails/1/EmailGroup/{key}
- Get all Email Groups
- Method: getPath:
/API/OData/ActivityDetails/1/EmailGroup
Reporting/ActivityDetails/1.0/EmailGroupSubscriptionStatus
The operations from the Reporting/ActivityDetails/1.0/EmailGroupSubscriptionStatus category.
- Get all Email Group Subscription status
- Method: getPath:
/API/OData/ActivityDetails/1/EmailGroupSubscriptionStatus
Reporting/ActivityDetails/1.0/EmailOpen
The operations from the Reporting/ActivityDetails/1.0/EmailOpen category.
- Get a single Email Open
- Method: getPath:
/API/OData/ActivityDetails/1/EmailOpen/{key}
- Get all Email Opens
- Method: getPath:
/API/OData/ActivityDetails/1/EmailOpen
Reporting/ActivityDetails/1.0/EmailSend
The operations from the Reporting/ActivityDetails/1.0/EmailSend category.
- Get a single Email Send
- Method: getPath:
/API/OData/ActivityDetails/1/EmailSend/{key}
- Get all Email Sends
- Method: getPath:
/API/OData/ActivityDetails/1/EmailSend
Reporting/ActivityDetails/1.0/EmailUnsubscribe
The operations from the Reporting/ActivityDetails/1.0/EmailUnsubscribe category.
- Get a single Email Unsubscribe
- Method: getPath:
/API/OData/ActivityDetails/1/EmailUnsubscribe/{key}
- Retrieves all Email Unsubscribes
- Method: getPath:
/API/OData/ActivityDetails/1/EmailUnsubscribe
Reporting/ActivityDetails/1.0/FormSubmission
The operations from the Reporting/ActivityDetails/1.0/FormSubmission category.
- Get a single Form Submission
- Method: getPath:
/API/OData/ActivityDetails/1/FormSubmission/{key}
- Get all Form Submissions
- Method: getPath:
/API/OData/ActivityDetails/1/FormSubmission
Reporting/ActivityDetails/1.0/LandingPageVisit
The operations from the Reporting/ActivityDetails/1.0/LandingPageVisit category.
- Get a single Landing Page Activity
- Method: getPath:
/API/OData/ActivityDetails/1/LandingPageVisit/{key}
- Get all Landing Page Activities
- Method: getPath:
/API/OData/ActivityDetails/1/LandingPageVisit
Reporting/ActivityDetails/1.0/Segment
The operations from the Reporting/ActivityDetails/1.0/Segment category.
- Get a single Segment
- Method: getPath:
/API/OData/ActivityDetails/1/Segment/{key}
- Get all Segments
- Method: getPath:
/API/OData/ActivityDetails/1/Segment
Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail
The operations from the Reporting/ActivityDetails/1.0/SpamUnsubscribesByEmail category.
- Get a single Spam Unsubscribe By Email
- Method: getPath:
/API/OData/ActivityDetails/1/SpamUnsubscribesByEmail/{key}
- Get all Spam Unsubscribes By Emails
- Method: getPath:
/API/OData/ActivityDetails/1/SpamUnsubscribesByEmail
Reporting/ActivityDetails/1.0/User
The operations from the Reporting/ActivityDetails/1.0/User category.
- Get a single User
- Method: getPath:
/API/OData/ActivityDetails/1/User/{key}
- Get all Users
- Method: getPath:
/API/OData/ActivityDetails/1/User
Reporting/CampaignAnalysis/1.0/Calendar
The operations from the Reporting/CampaignAnalysis/1.0/Calendar category.
- Get all Calendars
- Method: getPath:
/API/OData/CampaignAnalysis/1/Calendar
Reporting/CampaignAnalysis/1.0/Campaign
The operations from the Reporting/CampaignAnalysis/1.0/Campaign category.
- Get a single Campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}
- Get all Campaigns
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign
- Get email activities for a specified campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}/EmailActivities
- Get form activities for a specified campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}/FormActivities
- Get landing page activities for a specified campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}/LandingPageActivities
- Get lead activities for a specified campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}/LeadActivities
- Get web activities for a specified campaign
- Method: getPath:
/API/OData/CampaignAnalysis/1/Campaign/{key}/WebActivities
Reporting/CampaignAnalysis/1.0/EmailActivities
The operations from the Reporting/CampaignAnalysis/1.0/EmailActivities category.
- Get a single Email Activity
- Method: getPath:
/API/OData/CampaignAnalysis/1/EmailActivities/{key}
- Get all Email Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/EmailActivities
Reporting/CampaignAnalysis/1.0/EmailAsset
The operations from the Reporting/CampaignAnalysis/1.0/EmailAsset category.
- Get a single Email Asset
- Method: getPath:
/API/OData/CampaignAnalysis/1/EmailAsset/{key}
- Get all Email Assets
- Method: getPath:
/API/OData/CampaignAnalysis/1/EmailAsset
- Get Email activities for a specified Email Asset
- Method: getPath:
/API/OData/CampaignAnalysis/1/EmailAsset/{key}/EmailActivities
Reporting/CampaignAnalysis/1.0/ExternalActivityTotals
The operations from the Reporting/CampaignAnalysis/1.0/ExternalActivityTotals category.
- Get all External Activity Totals.
- Method: getPath:
/API/OData/CampaignAnalysis/1/ExternalActivityTotals
Reporting/CampaignAnalysis/1.0/FormActivities
The operations from the Reporting/CampaignAnalysis/1.0/FormActivities category.
- Get a single Form Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/FormActivities/{key}
- Get all Form Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/FormActivities
Reporting/CampaignAnalysis/1.0/LandingPageActivities
The operations from the Reporting/CampaignAnalysis/1.0/LandingPageActivities category.
- Get a single Landing Page Activity
- Method: getPath:
/API/OData/CampaignAnalysis/1/LandingPageActivities/{key}
- Get all Landing Page Activities.
- Method: getPath:
/API/OData/CampaignAnalysis/1/LandingPageActivities
Reporting/CampaignAnalysis/1.0/LandingPageAsset
The operations from the Reporting/CampaignAnalysis/1.0/LandingPageAsset category.
- Get a single Landing Page Asset
- Method: getPath:
/API/OData/CampaignAnalysis/1/LandingPageAsset/{key}
- Get all Landing Page Assets
- Method: getPath:
/API/OData/CampaignAnalysis/1/LandingPageAsset
- Get Landing Page Activities for a specified Landing Page Asset
- Method: getPath:
/API/OData/CampaignAnalysis/1/LandingPageAsset/{key}/LandingPageActivities
Reporting/CampaignAnalysis/1.0/LeadActivities
The operations from the Reporting/CampaignAnalysis/1.0/LeadActivities category.
- Get all Lead Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/LeadActivities
Reporting/CampaignAnalysis/1.0/MarketingActivities
The operations from the Reporting/CampaignAnalysis/1.0/MarketingActivities category.
- Get a single Marketing Activity
- Method: getPath:
/API/OData/CampaignAnalysis/1/MarketingActivities/{key}
- Get all Marketing Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/MarketingActivities
Reporting/CampaignAnalysis/1.0/Segment
The operations from the Reporting/CampaignAnalysis/1.0/Segment category.
- Get a single Segment
- Method: getPath:
/API/OData/CampaignAnalysis/1/Segment/{key}
- Get all Segments
- Method: getPath:
/API/OData/CampaignAnalysis/1/Segment
- Get Email Activities for a specified segment
- Method: getPath:
/API/OData/CampaignAnalysis/1/Segment/{key}/EmailActivities
- Get Form Activities for a specified segment
- Method: getPath:
/API/OData/CampaignAnalysis/1/Segment/{key}/FormActivities
Reporting/CampaignAnalysis/1.0/User
The operations from the Reporting/CampaignAnalysis/1.0/User category.
- Get a single User
- Method: getPath:
/API/OData/CampaignAnalysis/1/User/{key}
- Get all Users
- Method: getPath:
/API/OData/CampaignAnalysis/1/User
- Get campaigns for a specified user
- Method: getPath:
/API/OData/CampaignAnalysis/1/User/{key}/Campaigns
- Get Email Assets for a specified user
- Method: getPath:
/API/OData/CampaignAnalysis/1/User/{key}/EmailAssets
- Get Segments for a specified user
- Method: getPath:
/API/OData/CampaignAnalysis/1/User/{key}/Segments
Reporting/CampaignAnalysis/1.0/WebActivities
The operations from the Reporting/CampaignAnalysis/1.0/WebActivities category.
- Get a single Web Activity
- Method: getPath:
/API/OData/CampaignAnalysis/1/WebActivities/{key}
- Get all Web Activities
- Method: getPath:
/API/OData/CampaignAnalysis/1/WebActivities
Reporting/CampaignExternalActivity/1.0/ExternalActivities
The operations from the Reporting/CampaignExternalActivity/1.0/ExternalActivities category.
- Get a single External Activity
- Method: getPath:
/API/OData/CampaignExternalActivity/1/ExternalActivities/{key}
- Get all External Activities
- Method: getPath:
/API/OData/CampaignExternalActivity/1/ExternalActivities
Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes
The operations from the Reporting/CampaignExternalActivity/1.0/ExternalActivityAttributes category.
- Get a single External Activity Attribute record
- Method: getPath:
/API/OData/CampaignExternalActivity/1/ExternalActivityAttributes/{key}
- Get all External Activity Attributes
- Method: getPath:
/API/OData/CampaignExternalActivity/1/ExternalActivityAttributes
Reporting/FormSubmission/1.0/Calendar
The operations from the Reporting/FormSubmission/1.0/Calendar category.
- Get all Calendar records
- Method: getPath:
/API/OData/FormSubmission/1/Calendar
Reporting/FormSubmission/1.0/Campaign
The operations from the Reporting/FormSubmission/1.0/Campaign category.
- Get a single Campaign
- Method: getPath:
/API/OData/FormSubmission/1/Campaign/{key}
- Get all Campaigns
- Method: getPath:
/API/OData/FormSubmission/1/Campaign
- Get Form Submission activities for a specified Campaign ID
- Method: getPath:
/API/OData/FormSubmission/1/Campaign/{key}/FormSubmissionActivities
Reporting/FormSubmission/1.0/EmailAsset
The operations from the Reporting/FormSubmission/1.0/EmailAsset category.
- Get a single EmailAsset
- Method: getPath:
/API/OData/FormSubmission/1/EmailAsset/{key}
- Get all Email Assets
- Method: getPath:
/API/OData/FormSubmission/1/EmailAsset
- Get Form Submission activities for a specified Email Asset
- Method: getPath:
/API/OData/FormSubmission/1/EmailAsset/{key}/FormSubmissionActivities
Reporting/FormSubmission/1.0/FormAsset
The operations from the Reporting/FormSubmission/1.0/FormAsset category.
- Get a single Form Asset
- Method: getPath:
/API/OData/FormSubmission/1/FormAsset/{key}
- Get all Form Assets
- Method: getPath:
/API/OData/FormSubmission/1/FormAsset
Reporting/FormSubmission/1.0/FormSubmissionActivities
The operations from the Reporting/FormSubmission/1.0/FormSubmissionActivities category.
- Get all Form Submission Activities
- Method: getPath:
/API/OData/FormSubmission/1/FormSubmissionActivities
Reporting/FormSubmission/1.0/LandingPageAsset
The operations from the Reporting/FormSubmission/1.0/LandingPageAsset category.
- Get a single Landing Page Asset
- Method: getPath:
/API/OData/FormSubmission/1/LandingPageAsset/{key}
- Get all Landing Page Assets
- Method: getPath:
/API/OData/FormSubmission/1/LandingPageAsset
- Get Form Submission Activites for a specified Landing Page Asset
- Method: getPath:
/API/OData/FormSubmission/1/LandingPageAsset/{key}/FormSubmissionActivities
Reporting/FormSubmission/1.0/User
The operations from the Reporting/FormSubmission/1.0/User category.
- Get a single User
- Method: getPath:
/API/OData/FormSubmission/1/User/{key}
- Get all Users
- Method: getPath:
/API/OData/FormSubmission/1/User
- Get Campaigns for a specified User
- Method: getPath:
/API/OData/FormSubmission/1/User/{key}/Campaigns
- Get Email Asset for a specified User
- Method: getPath:
/API/OData/FormSubmission/1/User/{key}/EmailAssets
Reporting/FormSubmission/1.0/WebPage
The operations from the Reporting/FormSubmission/1.0/WebPage category.
- Get a single Web Page
- Method: getPath:
/API/OData/FormSubmission/1/WebPage/{key}
- Get all Form Submission Activities for a specified web page
- Method: getPath:
/API/OData/FormSubmission/1/WebPage/{key}/FormSubmissionActivities
- Get all Web Pages
- Method: getPath:
/API/OData/FormSubmission/1/WebPage
Reporting/LandingPageAnalysis/1.0/Calendar
The operations from the Reporting/LandingPageAnalysis/1.0/Calendar category.
- Get all Calendars
- Method: getPath:
/API/OData/LandingPageAnalysis/1/Calendar
Reporting/LandingPageAnalysis/1.0/LandingPageActivity
The operations from the Reporting/LandingPageAnalysis/1.0/LandingPageActivity category.
- Get all Landing Page Activities
- Method: getPath:
/API/OData/LandingPageAnalysis/1/LandingPageActivity
Reporting/LandingPageAnalysis/1.0/LandingPageAsset
The operations from the Reporting/LandingPageAnalysis/1.0/LandingPageAsset category.
- Get a single Landing Page Asset
- Method: getPath:
/API/OData/LandingPageAnalysis/1/LandingPageAsset/{key}
- Get all Landing Page Assets
- Method: getPath:
/API/OData/LandingPageAnalysis/1/LandingPageAsset
Reporting/OpportunityAnalysis/1.0/Account
The operations from the Reporting/OpportunityAnalysis/1.0/Account category.
- Get a single Account
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Account/{key}
- Get all Accounts
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Account
Reporting/OpportunityAnalysis/1.0/AccountCampaignScore
The operations from the Reporting/OpportunityAnalysis/1.0/AccountCampaignScore category.
- Get a single Account This endpoint is only available for Guided Campaign customers.
- Method: getPath:
/API/OData/OpportunityAnalysis/1/AccountCampaignScore/{key}
- Get all Account Campaign Scores This endpoint is only available for Guided Campaign customers.
- Method: getPath:
/API/OData/OpportunityAnalysis/1/AccountCampaignScore
Reporting/OpportunityAnalysis/1.0/AccountEngagement
The operations from the Reporting/OpportunityAnalysis/1.0/AccountEngagement category.
- Get a single AccountEngagement
- Method: getPath:
/API/OData/OpportunityAnalysis/1/AccountEngagement/{key}
- Get all Account Engagements
- Method: getPath:
/API/OData/OpportunityAnalysis/1/AccountEngagement
Reporting/OpportunityAnalysis/1.0/Contact
The operations from the Reporting/OpportunityAnalysis/1.0/Contact category.
- Get a single contact, Label access control is respected
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Contact/{key}
- Get all Contacts, Label access control is respected
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Contact
- Get all Opportunities for a specified Contact
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Contact/{key}/Opportunities
Reporting/OpportunityAnalysis/1.0/Opportunity
The operations from the Reporting/OpportunityAnalysis/1.0/Opportunity category.
- Get a single Opportunity
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Opportunity/{key}
- Get all Opportunities
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Opportunity
- Get Opportunities Revenue for a specified Opportunity
- Method: getPath:
/API/OData/OpportunityAnalysis/1/Opportunity/{key}/OpportunityRevenues
Reporting/OpportunityAnalysis/1.0/OpportunityRevenue
The operations from the Reporting/OpportunityAnalysis/1.0/OpportunityRevenue category.
- Get all Opportunity Revenues
- Method: getPath:
/API/OData/OpportunityAnalysis/1/OpportunityRevenue