All REST Endpoints

Application/1.0/Accounts
An Oracle Eloqua Account provides group contact information. Learn more about accounts.
Create an account
Method: post
Path: /api/REST/1.0/data/account
Delete an account
Method: delete
Path: /api/REST/1.0/data/account/{id}
Retrieve a list of accounts
Method: get
Path: /api/REST/1.0/data/accounts
Retrieve an account
Method: get
Path: /api/REST/1.0/data/account/{id}
Update an account
Method: put
Path: /api/REST/1.0/data/account/{id}
Application/1.0/Activities
Activities are tracked for individual contacts.
Retrieve a list of activities
Method: get
Path: /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: post
Path: /api/REST/1.0/assets/contact/field
Delete a contact field
Method: delete
Path: /api/REST/1.0/assets/contact/field/{id}
Retrieve a contact field
Method: get
Path: /api/REST/1.0/assets/contact/field/{id}
Retrieve a list of contact fields
Method: get
Path: /api/REST/1.0/assets/contact/fields
Update a contact field
Method: put
Path: /api/REST/1.0/assets/contact/field/{id}
Application/1.0/Contact list
Customized lists of contacts.
Create a contact list
Method: post
Path: /api/REST/1.0/assets/contact/list
Delete a contact list
Method: delete
Path: /api/REST/1.0/assets/contact/list/{id}
Retrieve a contact list
Method: get
Path: /api/REST/1.0/assets/contact/list/{id}
Retrieve a list of contact lists
Method: get
Path: /api/REST/1.0/assets/contact/lists
Update a contact list
Method: put
Path: /api/REST/1.0/assets/contact/list/{id}
Application/1.0/Contact segments
Segments, found under the Contacts tab in Eloqua, are groups of contacts that are generated based on filter criteria and contact lists. Segments can filter contacts based on criteria like whether or not they receive a newspaper, or whether or not they visited a landing page. Learn more about segments.
Create a contact segment
Method: post
Path: /api/REST/1.0/assets/contact/segment
Delete a contact segment
Method: delete
Path: /api/REST/1.0/assets/contact/segment/{id}
Retrieve a contact segment
Method: get
Path: /api/REST/1.0/assets/contact/segment/{id}
Retrieve a list of contact segments
Method: get
Path: /api/REST/1.0/assets/contact/segments
Update a contact segment
Method: put
Path: /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: post
Path: /api/REST/1.0/data/contact
Delete a contact
Method: delete
Path: /api/REST/1.0/data/contact/{id}
Retrieve a contact
Method: get
Path: /api/REST/1.0/data/contact/{id}
Retrieve a list of contacts
Method: get
Path: /api/REST/1.0/data/contacts
Update a contact
Method: put
Path: /api/REST/1.0/data/contact/{id}
Application/1.0/Content sections
Content sections allow you to create custom dynamic content to use inside assets such as emails and landing pages. Learn more about content sections.
Create a content section
Method: post
Path: /api/REST/1.0/assets/contentSection
Delete a content section
Method: delete
Path: /api/REST/1.0/assets/contentSection/{id}
Retrieve a content section
Method: get
Path: /api/REST/1.0/assets/contentSection/{id}
Retrieve a list of content sections
Method: get
Path: /api/REST/1.0/assets/contentSections
Update a content section
Method: put
Path: /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: post
Path: /api/REST/1.0/data/customObject/{id}
Retrieve a list of custom object data
Method: get
Path: /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: post
Path: /api/REST/1.0/assets/customObject
Delete a custom object
Method: delete
Path: /api/REST/1.0/assets/customObject/{id}
Retrieve a custom object
Method: get
Path: /api/REST/1.0/assets/customObject/{id}
Retrieve a list of custom objects
Method: get
Path: /api/REST/1.0/assets/customObjects
Update a custom object
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/email/folder
Delete an email folder
Method: delete
Path: /api/REST/1.0/assets/email/folder/{id}
Retrieve a list of email folders
Method: get
Path: /api/REST/1.0/assets/email/folders
Retrieve an email folder
Method: get
Path: /api/REST/1.0/assets/email/folder/{id}
Update an email folder
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/email/footer
Delete an email footer
Method: delete
Path: /api/REST/1.0/assets/email/footer/{id}
Retrieve a list of email footers
Method: get
Path: /api/REST/1.0/assets/email/footers
Retrieve an email footer
Method: get
Path: /api/REST/1.0/assets/email/footer/{id}
Update an email footer
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/email/group
Delete an email group
Method: delete
Path: /api/REST/1.0/assets/email/group/{id}
Retrieve a list of email groups
Method: get
Path: /api/REST/1.0/assets/email/groups
Retrieve an email group
Method: get
Path: /api/REST/1.0/assets/email/group/{id}
Update an email group
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/email/header
Delete an email header
Method: delete
Path: /api/REST/1.0/assets/email/header/{id}
Retrieve a list of email headers
Method: get
Path: /api/REST/1.0/assets/email/headers
Retrieve an email header
Method: get
Path: /api/REST/1.0/assets/email/header/{id}
Update an email header
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/email
Delete an email
Method: delete
Path: /api/REST/1.0/assets/email/{id}
Retrieve a list of emails
Method: get
Path: /api/REST/1.0/assets/emails
Retrieve an email
Method: get
Path: /api/REST/1.0/assets/email/{id}
Update an email
Method: put
Path: /api/REST/1.0/assets/email/{id}
Application/1.0/Form data
Learning about your prospects and contacts can be accomplished in a few different ways, the primary method, however, is by placing a form on a landing page that is reached by a click-through link in a marketing email. In this fashion, your contacts can provide varying degrees of personal information that you can then use in customizing future communications. Learn more about forms.
Create form data for a single form
Method: post
Path: /api/REST/1.0/data/form/{id}
Retrieve a single form submission
Method: get
Path: /api/REST/1.0/data/form/{formId}/formData/{formSubmitJobId}
Retrieve all form submissions for a form
Method: get
Path: /api/REST/1.0/data/form/{formId}/formData
Retrieve form data for a form
Method: get
Path: /api/REST/1.0/data/form/{id}
Application/1.0/Forms
Learning about your prospects and contacts can be accomplished in a few different ways. The primary method, however, is by placing a form on a landing page that is reached by a click-through link in a marketing email. Your contacts can provide varying degrees of personal information that you can then use in customizing future communications. For example, a simple form could ask for just First Name, Last Name, Email Address, and Industry. Once those fields are completed and submitted through Oracle Eloqua, it is possible to use this information to target these prospects in campaigns that correspond with their digital body-language. Learn more about Forms.
Create a form
Method: post
Path: /api/REST/1.0/assets/form
Delete a form
Method: delete
Path: /api/REST/1.0/assets/form/{id}
Retrieve a form
Method: get
Path: /api/REST/1.0/assets/form/{id}
Retrieve a list of forms
Method: get
Path: /api/REST/1.0/assets/forms
Update a form
Method: put
Path: /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: delete
Path: /api/REST/1.0/assets/image/{id}
Retrieve a list of images
Method: get
Path: /api/REST/1.0/assets/images
Retrieve an image
Method: get
Path: /api/REST/1.0/assets/image/{id}
Update an image
Method: put
Path: /api/REST/1.0/assets/image/{id}
Upload an image
Method: post
Path: /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: post
Path: /api/REST/1.0/assets/landingPage
Delete a landing page
Method: delete
Path: /api/REST/1.0/assets/landingPage/{id}
Retrieve a landing page
Method: get
Path: /api/REST/1.0/assets/landingPage/{id}
Retrieve a list of landing pages
Method: get
Path: /api/REST/1.0/assets/landingPages
Update a landing page
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/microsite
Delete a microsite
Method: delete
Path: /api/REST/1.0/assets/microsite/{id}
Retrieve a list of microsites
Method: get
Path: /api/REST/1.0/assets/microsites
Retrieve a microsite
Method: get
Path: /api/REST/1.0/assets/microsite/{id}
Update a microsite
Method: put
Path: /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: post
Path: /api/REST/1.0/assets/optionList
Delete an option list
Method: delete
Path: /api/REST/1.0/assets/optionList/{id}
Retrieve a list of option lists
Method: get
Path: /api/REST/1.0/assets/optionLists
Retrieve an option list
Method: get
Path: /api/REST/1.0/assets/optionList/{id}
Update an option list
Method: put
Path: /api/REST/1.0/assets/optionList/{id}
Application/1.0/Users
This endpoint refers to users for your eloqua instance. The API allows you to modify such things as user time preference. Learn more about emails.
Retrieve a list of users
Method: get
Path: /api/REST/1.0/system/users
Retrieve a user
Method: get
Path: /api/REST/1.0/system/user/{id}
Update a user
Method: put
Path: /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: post
Path: /api/REST/2.0/assets/account/group
Delete an account group
Method: delete
Path: /api/REST/2.0/assets/account/group/{id}
Retrieve a list of account groups
Method: get
Path: /api/REST/2.0/assets/account/groups
Retrieve an account group
Method: get
Path: /api/REST/2.0/assets/account/group/{id}
Update an account group
Method: put
Path: /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: get
Path: /api/REST/2.0/data/account/{id}/membership
Retrieve account information
Method: post
Path: /api/REST/2.0/data/accounts
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: post
Path: /api/REST/2.0/data/auditLog/reportExport
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: post
Path: /api/REST/2.0/assets/campaign/active/{id}
Create a campaign
Method: post
Path: /api/REST/2.0/assets/campaign
Deactivate a campaign
Method: post
Path: /api/REST/2.0/assets/campaign/draft/{id}
Delete a campaign
Method: delete
Path: /api/REST/2.0/assets/campaign/{id}
Retrieve a campaign
Method: get
Path: /api/REST/2.0/assets/campaign/{id}
Retrieve a list of campaigns
Method: get
Path: /api/REST/2.0/assets/campaigns
Update a campaign
Method: put
Path: /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: post
Path: /api/REST/2.0/assets/contact/segment
Create a copy of a contact segment
Method: post
Path: /api/REST/2.0/assets/contact/segment/{id}/copy
Delete a contact segment
Method: delete
Path: /api/REST/2.0/assets/contact/segment/{id}
Retrieve a contact segment
Method: get
Path: /api/REST/2.0/assets/contact/segment/{id}
Retrieve a list of contact segments
Method: get
Path: /api/REST/2.0/assets/contact/segments
Update a contact segment
Method: put
Path: /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: post
Path: /api/REST/2.0/data/contacts
Retrieve contact list membership information for a contact
Method: get
Path: /api/REST/2.0/data/contact/{id}/membership
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: post
Path: /api/REST/2.0/data/customObject/{parentId}/instance
Delete custom object data
Method: delete
Path: /api/REST/2.0/data/customObject/{parentId}/instance/{id}
Retrieve a list of custom object data
Method: get
Path: /api/REST/2.0/data/customObject/{parentId}/instances
Retrieve custom object data
Method: get
Path: /api/REST/2.0/data/customObject/{parentId}/instance/{id}
Update custom object data
Method: put
Path: /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: post
Path: /api/REST/2.0/assets/customObject
Delete a custom object
Method: delete
Path: /api/REST/2.0/assets/customObject/{id}
Retrieve a custom object
Method: get
Path: /api/REST/2.0/assets/customObject/{id}
Retrieve a list of custom objects
Method: get
Path: /api/REST/2.0/assets/customObjects
Update a custom object
Method: put
Path: /api/REST/2.0/assets/customObject/{id}
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: post
Path: /api/REST/2.0/assets/email/deployment
Retrieve an email deployment
Method: get
Path: /api/REST/2.0/assets/email/deployment/{id}
Application/2.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. 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.
Create an email
Method: post
Path: /api/REST/2.0/assets/email
Delete an email
Method: delete
Path: /api/REST/2.0/assets/email/{id}
Retrieve a list of emails
Method: get
Path: /api/REST/2.0/assets/emails
Retrieve an email
Method: get
Path: /api/REST/2.0/assets/email/{id}
Update an email
Method: put
Path: /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: post
Path: /api/REST/2.0/data/eventRegistration/{parentId}/instance
Delete an event registrant
Method: delete
Path: /api/REST/2.0/data/eventRegistration/{parentId}/instance/{id}
Retrieve a list of event registrants
Method: get
Path: /api/REST/2.0/data/eventRegistration/{parentId}/instances
Retrieve an event registrant
Method: get
Path: /api/REST/2.0/data/eventRegistration/{parentId}/instance/{id}
Update an event registrant
Method: put
Path: /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: post
Path: /api/REST/2.0/assets/eventRegistration
Delete an event
Method: delete
Path: /api/REST/2.0/assets/eventRegistration/{id}
Retrieve a list of events
Method: get
Path: /api/REST/2.0/assets/eventRegistrations
Retrieve an event
Method: get
Path: /api/REST/2.0/assets/eventRegistration/{id}
Update an event
Method: put
Path: /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: post
Path: /api/REST/2.0/data/activity
Retrieve an external activity
Method: get
Path: /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: post
Path: /api/REST/2.0/assets/external/type
Delete an external asset type
Method: delete
Path: /api/REST/2.0/assets/external/type/{id}
Retrieve a list of external asset types
Method: get
Path: /api/REST/2.0/assets/external/types
Retrieve an external asset type
Method: get
Path: /api/REST/2.0/assets/external/type/{id}
Update an external asset type
Method: put
Path: /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: post
Path: /api/REST/2.0/assets/external
Delete an external asset
Method: delete
Path: /api/REST/2.0/assets/external/{id}
Retrieve a list of external assets
Method: get
Path: /api/REST/2.0/assets/externals
Retrieve an external asset
Method: get
Path: /api/REST/2.0/assets/external/{id}
Update an external asset
Method: put
Path: /api/REST/2.0/assets/external/{id}
Application/2.0/Form data
Learning about your prospects and contacts can be accomplished in a few different ways, the primary method, however, is by placing a form on a landing page that is reached by a click-through link in a marketing email. In this fashion, your contacts can provide varying degrees of personal information that you can then use in customizing future communications. Learn more about Forms. Creating and updating landing pages with the type ResponsiveHtmlContent is not supported. If you use these endpoints with this landing page type, we cannot guarantee your landing page will be responsive.
Create form data for a single form
Method: post
Path: /api/REST/2.0/data/form/{id}
Delete the data of a form
Method: delete
Path: /api/REST/2.0/data/form/{id}/datarow/{rowId}
Retrieve a single form submission
Method: get
Path: /api/REST/2.0/data/form/{formId}/formData/{formSubmitJobId}
Retrieve all form submissions for a form
Method: get
Path: /api/REST/2.0/data/form/{formId}/formData
Retrieve form data for a form
Method: get
Path: /api/REST/2.0/data/form/{id}
Application/2.0/Forms
Learning about your prospects and contacts can be accomplished in a few different ways. The primary method, however, is by placing a form on a landing page that is reached by a click-through link in a marketing email. Your contacts can provide varying degrees of personal information that you can then use in customizing future communications. For example, a simple form could ask for just First Name, Last Name, Email Address, and Industry. Once those fields are completed and submitted through Oracle Eloqua, it is possible to use this information to target these prospects in campaigns that correspond with their digital body-language. Learn more about Forms.
Create a form
Method: post
Path: /api/REST/2.0/assets/form
Delete a form
Method: delete
Path: /api/REST/2.0/assets/form/{id}
Partially update a form
Method: patch
Path: /api/REST/2.0/assets/form/{id}
Retrieve a form
Method: get
Path: /api/REST/2.0/assets/form/{id}
Retrieve a list of forms
Method: get
Path: /api/REST/2.0/assets/forms
Update a form
Method: put
Path: /api/REST/2.0/assets/form/{id}
Application/2.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: post
Path: /api/REST/2.0/assets/landingPage
Delete a landing page
Method: delete
Path: /api/REST/2.0/assets/landingPage/{id}
Retrieve a landing page
Method: get
Path: /api/REST/2.0/assets/landingPage/{id}
Retrieve a list of landing pages
Method: get
Path: /api/REST/2.0/assets/landingPages
Update a landing page
Method: put
Path: /api/REST/2.0/assets/landingPage/{id}
Application/2.0/Programs
Program Canvas is an easy to use, drag-and-drop whiteboard that allows you to transform data within Oracle Eloqua in real-time. Using Program Canvas, you can build programs that automate repetitive manual tasks related to various marketing functions like CRM integration, data cleansing, and security label management. Learn more about Programs.
Activate a program
Method: post
Path: /api/REST/2.0/assets/program/active/{id}
Create a program
Method: post
Path: /api/REST/2.0/assets/program
Deactivate a program
Method: post
Path: /api/REST/2.0/assets/program/draft/{id}
Delete a program
Method: delete
Path: /api/REST/2.0/assets/program/{id}
Pause a program
Method: post
Path: /api/REST/2.0/assets/program/pause/{id}
Retrieve a list of programs
Method: get
Path: /api/REST/2.0/assets/programs
Retrieve a program
Method: get
Path: /api/REST/2.0/assets/program/{id}
Update a program
Method: put
Path: /api/REST/2.0/assets/program/{id}
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: get
Path: /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: get
Path: /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: post
Path: /api/bulk/2.0/accounts/exports
Create an account import definition
Method: post
Path: /api/bulk/2.0/accounts/imports
Create an account sync action definition
Method: post
Path: /api/bulk/2.0/accounts/syncActions
Delete an account export definition
Method: delete
Path: /api/bulk/2.0/accounts/exports/{id}
Delete an account export definition's data
Method: delete
Path: /api/bulk/2.0/accounts/exports/{id}/data
Delete an account import definition
Method: delete
Path: /api/bulk/2.0/accounts/imports/{id}
Delete an account import definition's data
Method: delete
Path: /api/bulk/2.0/accounts/imports/{id}/data
Delete an account sync action definition
Method: delete
Path: /api/bulk/2.0/accounts/syncActions/{id}
Delete sync data for an account sync action definition
Method: delete
Path: /api/bulk/2.0/accounts/syncActions/{id}/data
Retrieve a list of account export definitions
Method: get
Path: /api/bulk/2.0/accounts/exports
Retrieve a list of account field definitions
Method: get
Path: /api/bulk/2.0/accounts/fields
Retrieve a list of account import definitions
Method: get
Path: /api/bulk/2.0/accounts/imports
Retrieve a list of account list definitions
Method: get
Path: /api/bulk/2.0/accounts/lists
Retrieve a list of account sync action definitions
Method: get
Path: /api/bulk/2.0/accounts/syncActions
Retrieve an account export definition
Method: get
Path: /api/bulk/2.0/accounts/exports/{id}
Retrieve an account export definition's synced data
Method: get
Path: /api/bulk/2.0/accounts/exports/{id}/data
Retrieve an account field definition
Method: get
Path: /api/bulk/2.0/accounts/fields/{id}
Retrieve an account import definition
Method: get
Path: /api/bulk/2.0/accounts/imports/{id}
Retrieve an account list definition
Method: get
Path: /api/bulk/2.0/accounts/lists/{id}
Retrieve an account sync action definition
Method: get
Path: /api/bulk/2.0/accounts/syncActions/{id}
Update an account export definition
Method: put
Path: /api/bulk/2.0/accounts/exports/{id}
Update an account import definition
Method: put
Path: /api/bulk/2.0/accounts/imports/{id}
Update an account sync action definition
Method: put
Path: /api/bulk/2.0/accounts/syncActions/{id}
Upload account sync action data
Method: post
Path: /api/bulk/2.0/accounts/syncActions/{id}/data
Upload data for a specified account import definition
Method: post
Path: /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: post
Path: /api/bulk/2.0/activities/exports
Create an activity import definition
Method: post
Path: /api/bulk/2.0/activities/imports
Delete an activity export definition
Method: delete
Path: /api/bulk/2.0/activities/exports/{id}
Delete an activity export definition's data
Method: delete
Path: /api/bulk/2.0/activities/exports/{id}/data
Delete an activity import definition
Method: delete
Path: /api/bulk/2.0/activities/imports/{id}
Delete an activity import definition's data
Method: delete
Path: /api/bulk/2.0/activities/imports/{id}/data
Retrieve a list of activity export definitions
Method: get
Path: /api/bulk/2.0/activities/exports
Retrieve a list of activity field definitions
Method: get
Path: /api/bulk/2.0/activities/fields
Retrieve a list of activity import definitions
Method: get
Path: /api/bulk/2.0/activities/imports
Retrieve an activity export definition
Method: get
Path: /api/bulk/2.0/activities/exports/{id}
Retrieve an activity export's synced data
Method: get
Path: /api/bulk/2.0/activities/exports/{id}/data
Retrieve an activity field definition
Method: get
Path: /api/bulk/2.0/activities/fields/{id}
Retrieve an activity import definition
Method: get
Path: /api/bulk/2.0/activities/imports/{id}
Update an activity export definition
Method: put
Path: /api/bulk/2.0/activities/exports/{id}
Update an activity import definition
Method: put
Path: /api/bulk/2.0/activities/imports/{id}
Upload data for a specified activity import definition
Method: post
Path: /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: post
Path: /api/bulk/2.0/campaignResponses/exports
Create a campaign response import definition
Method: post
Path: /api/bulk/2.0/campaignResponses/imports
Delete a campaign response export definition
Method: delete
Path: /api/bulk/2.0/campaignResponses/exports/{id}
Delete a campaign response import definition
Method: delete
Path: /api/bulk/2.0/campaignResponses/imports/{id}
Delete the synced data for a campaign response export definition
Method: delete
Path: /api/bulk/2.0/campaignResponses/exports/{id}/data
Delete the synced data for a campaign response import definition
Method: delete
Path: /api/bulk/2.0/campaignResponses/imports/{id}/data
Retrieve a campaign response export definition
Method: get
Path: /api/bulk/2.0/campaignResponses/exports/{id}
Retrieve a campaign response field definition
Method: get
Path: /api/bulk/2.0/campaignResponses/fields/{id}
Retrieve a campaign response import definition
Method: get
Path: /api/bulk/2.0/campaignResponses/imports/{id}
Retrieve a list of campaign response export definitions
Method: get
Path: /api/bulk/2.0/campaignResponses/exports
Retrieve a list of campaign response import definitions
Method: get
Path: /api/bulk/2.0/campaignResponses/imports
Retrieve all campaign response fields
Method: get
Path: /api/bulk/2.0/campaignResponses/fields
Retrieve the synced data for a campaign response export definition
Method: get
Path: /api/bulk/2.0/campaignResponses/exports/{id}/data
Update a campaign response export definition
Method: put
Path: /api/bulk/2.0/campaignResponses/exports/{id}
Update a campaign response import definition
Method: put
Path: /api/bulk/2.0/campaignResponses/imports/{id}
Upload data for a campaign response import definition
Method: post
Path: /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: get
Path: /api/bulk/2.0/campaigns/fields/{id}
Retrieve a list of campaign fields
Method: get
Path: /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: post
Path: /api/bulk/2.0/contacts/exports
Create a contact import definition
Method: post
Path: /api/bulk/2.0/contacts/imports
Create a contact sync action definition
Method: post
Path: /api/bulk/2.0/contacts/syncActions
Delete a contact export definition
Method: delete
Path: /api/bulk/2.0/contacts/exports/{id}
Delete a contact export definition's data
Method: delete
Path: /api/bulk/2.0/contacts/exports/{id}/data
Delete a contact import definition
Method: delete
Path: /api/bulk/2.0/contacts/imports/{id}
Delete a contact import definition's data
Method: delete
Path: /api/bulk/2.0/contacts/imports/{id}/data
Delete a contact sync action definition
Method: delete
Path: /api/bulk/2.0/contacts/syncActions/{id}
Delete sync data for a contact sync action definition
Method: delete
Path: /api/bulk/2.0/contacts/syncActions/{id}/data
Retrieve a contact export definition
Method: get
Path: /api/bulk/2.0/contacts/exports/{id}
Retrieve a contact export definition's synced data
Method: get
Path: /api/bulk/2.0/contacts/exports/{id}/data
Retrieve a contact field definition
Method: get
Path: /api/bulk/2.0/contacts/fields/{id}
Retrieve a contact filter
Method: get
Path: /api/bulk/2.0/contacts/filters/{id}
Retrieve a contact import definition
Method: get
Path: /api/bulk/2.0/contacts/imports/{id}
Retrieve a contact list
Method: get
Path: /api/bulk/2.0/contacts/lists/{id}
Retrieve a contact segment
Method: get
Path: /api/bulk/2.0/contacts/segments/{id}
Retrieve a contact sync action definition
Method: get
Path: /api/bulk/2.0/contacts/syncActions/{id}
Retrieve a lead scoring model
Method: get
Path: /api/bulk/2.0/contacts/scoring/models/{id}
Retrieve a list of contact export definitions
Method: get
Path: /api/bulk/2.0/contacts/exports
Retrieve a list of contact field definitions
Method: get
Path: /api/bulk/2.0/contacts/fields
Retrieve a list of contact filters
Method: get
Path: /api/bulk/2.0/contacts/filters
Retrieve a list of contact import definitions
Method: get
Path: /api/bulk/2.0/contacts/imports
Retrieve a list of contact lists
Method: get
Path: /api/bulk/2.0/contacts/lists
Retrieve a list of contact segments
Method: get
Path: /api/bulk/2.0/contacts/segments
Retrieve a list of contact sync action definitions
Method: get
Path: /api/bulk/2.0/contacts/syncActions
Retrieve a list of lead scoring models
Method: get
Path: /api/bulk/2.0/contacts/scoring/models
Update a contact export definition
Method: put
Path: /api/bulk/2.0/contacts/exports/{id}
Update a contact import definition
Method: put
Path: /api/bulk/2.0/contacts/imports/{id}
Update a contact sync action definition
Method: put
Path: /api/bulk/2.0/contacts/syncActions/{id}
Upload contact sync action data
Method: post
Path: /api/bulk/2.0/contacts/syncActions/{id}/data
Upload data for a contact import definition
Method: post
Path: /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: post
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions
Create an export definition for a custom object
Method: post
Path: /api/bulk/2.0/customObjects/{parentId}/exports
Create an import definition for a custom object
Method: post
Path: /api/bulk/2.0/customObjects/{parentId}/imports
Delete a custom object export definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/exports/{id}
Delete a custom object import definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/imports/{id}
Delete a custom object sync action definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
Delete sync data for a custom object sync action definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data
Delete synced data for a custom object import definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/imports/{id}/data
Delete the synced data for a custom object export definition
Method: delete
Path: /api/bulk/2.0/customObjects/{parentId}/exports/{id}/data
Retrieve a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}
Retrieve a custom object field definition
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/fields/{id}
Retrieve a custom object sync action definition for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
Retrieve a list of custom objects
Method: get
Path: /api/bulk/2.0/customObjects
Retrieve a list of export definitions for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/exports
Retrieve a list of import definitions for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/imports
Retrieve a list of sync action definitions for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions
Retrieve a list of the fields for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/fields
Retrieve an import definition for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/imports/{id}
Retrieve the specified export definition for a custom object
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/exports/{id}
Retrieve the synced data for a custom object export definition
Method: get
Path: /api/bulk/2.0/customObjects/{parentId}/exports/{id}/data
Update a custom object sync action definition
Method: put
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}
Update an export definition for a custom object
Method: put
Path: /api/bulk/2.0/customObjects/{parentId}/exports/{id}
Update an import definition for a custom object
Method: put
Path: /api/bulk/2.0/customObjects/{parentId}/imports/{id}
Upload custom object sync action data
Method: post
Path: /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data
Upload data for a custom object import definition
Method: post
Path: /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: post
Path: /api/bulk/2.0/emailAddresses/imports
Delete an email address import definition
Method: delete
Path: /api/bulk/2.0/emailAddresses/imports/{id}
Delete an email address import definition's synced data
Method: delete
Path: /api/bulk/2.0/emailAddresses/imports/{id}/data
Retrieve a list of email address import definitions
Method: get
Path: /api/bulk/2.0/emailAddresses/imports
Retrieve an email address import definition
Method: get
Path: /api/bulk/2.0/emailAddresses/imports/{id}
Submit data for an email address import
Method: post
Path: /api/bulk/2.0/emailAddresses/imports/{id}/data
Update an email address import definition
Method: put
Path: /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: get
Path: /api/bulk/2.0/emailGroups
Retrieve an email group
Method: get
Path: /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: post
Path: /api/bulk/2.0/events/{parentId}/exports
Create an import definition for an event
Method: post
Path: /api/bulk/2.0/events/{parentId}/imports
Delete an export definition for an event
Method: delete
Path: /api/bulk/2.0/events/{parentId}/exports/{id}
Delete an import definition for an event
Method: delete
Path: /api/bulk/2.0/events/{parentId}/imports/{id}
Delete the synced data for an event export definition
Method: delete
Path: /api/bulk/2.0/events/{parentId}/exports/{id}/data
Delete the synced data for an event import definition
Method: delete
Path: /api/bulk/2.0/events/{parentId}/imports/{id}/data
Retrieve a list of events
Method: get
Path: /api/bulk/2.0/events
Retrieve a list of export definitions for an event
Method: get
Path: /api/bulk/2.0/events/{id}/exports
Retrieve a list of import definitions for an event
Method: get
Path: /api/bulk/2.0/events/{id}/imports
Retrieve a list of the fields for an event
Method: get
Path: /api/bulk/2.0/events/{id}/fields
Retrieve an event
Method: get
Path: /api/bulk/2.0/events/{id}
Retrieve an event field definition
Method: get
Path: /api/bulk/2.0/events/{parentId}/fields/{id}
Retrieve an export definition for an event
Method: get
Path: /api/bulk/2.0/events/{parentId}/exports/{id}
Retrieve an import definition for an event
Method: get
Path: /api/bulk/2.0/events/{parentId}/imports/{id}
Retrieve the synced data for an event export definition
Method: get
Path: /api/bulk/2.0/events/{parentId}/exports/{id}/data
Update an export definition for an event
Method: put
Path: /api/bulk/2.0/events/{parentId}/exports/{id}
Update an import definition for an event
Method: put
Path: /api/bulk/2.0/events/{parentId}/imports/{id}
Upload data for an event import definition
Method: post
Path: /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: get
Path: /api/bulk/2.0/exports/data
Retrieve a list of exports
Method: get
Path: /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: get
Path: /api/bulk/2.0/imports/data
Retrieve a list of import priorities
Method: get
Path: /api/bulk/2.0/imports/priorities
Retrieve a list of imports
Method: get
Path: /api/bulk/2.0/imports
Retrieve an import priority
Method: get
Path: /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: post
Path: /api/bulk/2.0/opportunities/contacts/imports
Create an opportunity import definition
Method: post
Path: /api/bulk/2.0/opportunities/imports
Delete an opportunity contact linkage import definition
Method: delete
Path: /api/bulk/2.0/opportunities/contacts/imports/{id}
Delete an opportunity import definition
Method: delete
Path: /api/bulk/2.0/opportunities/imports/{id}
Delete the synced data for an opportunity contact linkage import definition
Method: delete
Path: /api/bulk/2.0/opportunities/contacts/imports/{id}/data
Delete the synced data for an opportunity import definition
Method: delete
Path: /api/bulk/2.0/opportunities/imports/{id}/data
Retrieve a list of opportunity contact linkage import definitions
Method: get
Path: /api/bulk/2.0/opportunities/contacts/imports
Retrieve a list of opportunity fields
Method: get
Path: /api/bulk/2.0/opportunities/fields
Retrieve a list of opportunity import definitions
Method: get
Path: /api/bulk/2.0/opportunities/imports
Retrieve an opportunity contact linkage import definition
Method: get
Path: /api/bulk/2.0/opportunities/contacts/imports/{id}
Retrieve an opportunity field definition
Method: get
Path: /api/bulk/2.0/opportunities/fields/{id}
Retrieve an opportunity import definition
Method: get
Path: /api/bulk/2.0/opportunities/imports/{id}
Update an opportunity contact linkage import definition
Method: put
Path: /api/bulk/2.0/opportunities/contacts/imports/{id}
Update an opportunity import definition
Method: put
Path: /api/bulk/2.0/opportunities/imports/{id}
Upload data for an opportunity contact linkage import definition
Method: post
Path: /api/bulk/2.0/opportunities/contacts/imports/{id}/data
Upload data for an opportunity import definition
Method: post
Path: /api/bulk/2.0/opportunities/imports/{id}/data
Bulk/2.0/syncActions
The operations from the Bulk/2.0/syncActions category.
Retrieve a list of sync action definitions
Method: get
Path: /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: post
Path: /api/bulk/2.0/syncs
Delete sync data
Method: delete
Path: /api/bulk/2.0/syncs/{id}/data
Retrieve a list of syncs
Method: get
Path: /api/bulk/2.0/syncs
Retrieve a sync
Method: get
Path: /api/bulk/2.0/syncs/{id}
Retrieve a sync's logs
Method: get
Path: /api/bulk/2.0/syncs/{id}/logs
Retrieve an export sync's data
Method: get
Path: /api/bulk/2.0/syncs/{id}/data
Retrieve import sync failure data
Method: get
Path: /api/bulk/2.0/syncs/{id}/rejects