Marketing Cloud Account Engagement API (fka Pardot API)

Number of APIs: 131

The Salesforce Marketing Cloud Account Engagement (formerly known as Pardot) API collection contains requests for the V5 Synchronous API.

⚠️ Disclaimers:

• This collection is provided as-is. It's not officially supported by Salesforce or covered by SLAs.

• API documentation is not provided with the collection. Please refer to the official documentation.

ℹ️ Report issues and ask questions here.

Get started

Follow this documentation to get started with the collection.

Authentication

The collection works with OAuth 2.0 implicit grant. It comes predefined with collection variables (clientId, oauth_domain, domain), which are also set in the [Marketing Cloud Account Engagement Environment Template] Follow the steps below to authenticate:

1. Configure Variables in the Collection, and Environment (if using an Environment).

   1. Configure the oauth_domain for your login host, predefined to login.salesforce.com
   2. Configure the domain for your environment, predefined to pi.pardot.com

   3. Configure the clientId of your connected app

      1. Callers can use the predefined value instead of creating their own Connected App for hassle-free authentication

   4. Configure the businessUnitId for your Org

      1. Used when making requests, no predefined value since it is unique to each Org

2. Click Get New Access Token under the Authorization tab

3. Login in to your org in the Web UI and accept access from the Qodex app

4. Click Use Token

5. Run your requests

Variables Reference

The collection relies on the following variables:

1. Version 5-Email Template - Delete DELETE https://{{domain}}/api/v5/objects/email-templates/:id

2. Version 5-Form Handler - Update PATCH https://{{domain}}/api/v5/objects/form-handlers/:id?fields=id,name,salesforceId,campaignId,embedCode,createdAt,updatedAt,createdById,updatedById,trackerDomainId,isDataForwarded,successLocation,errorLocation,isAlwaysEmail,isCookieless,isDeleted,folderId,url

3. Version 5-Landing Page - Query GET https://{{domain}}/api/v5/objects/landing-pages?fields=id,name,salesforceId,isDeleted,createdById,createdAt,updatedById,updatedAt,campaignId,formId,layoutTemplateId,title,description,isDoNotIndex,vanityUrl,vanityUrlPath,layoutType,layoutTableBorder,redirectLocation,isUseRedirectLocation,bitlyIsPersonalized,bitlyShortUrl,trackerDomainId,folderId,url,archiveDate

4. Version 5-Lifecycle Stage - Read GET https://{{domain}}/api/v5/objects/lifecycle-stages/:id?fields=id,matchType,isLocked,name,position,createdAt,updatedAt,isDeleted

5. Version 5-Engagement Studio Program - Download Program Structure GET https://{{domain}}/api/v5/objects/engagement-studio-programs/:id/download-program-structure

6. Version 5-Visitor - Assign To Prospect POST https://{{domain}}/api/v5/objects/visitors/:id/do/assignToProspect

7. Version 5-Export - Read GET https://{{domain}}/api/v5/exports/:id?fields=id,status,isExpired,procedure,createdAt,updatedAt,fields,resultRefs,createdById,updatedById,includeByteOrderMark,legacyDateFormat,maxFileSizeBytes,createdBy.id,createdBy.email,createdBy.firstName,createdBy.lastName,createdBy.username,createdBy.jobTitle,createdBy.role,createdBy.roleName,createdBy.salesforceId,createdBy.createdAt,createdBy.updatedAt,createdBy.isDeleted,createdBy.createdById,createdBy.updatedById,createdBy.tagReplacementLanguage,updatedBy.id,updatedBy.email,updatedBy.firstName,updatedBy.lastName,updatedBy.username,updatedBy.jobTitle,updatedBy.role,updatedBy.roleName,updatedBy.salesforceId,updatedBy.createdAt,updatedBy.updatedAt,updatedBy.isDeleted,updatedBy.createdById,updatedBy.updatedById,updatedBy.tagReplacementLanguage

8. Version 5-Export - Download Results GET https://{{domain}}/api/v5/exports/:id/results/:fileId

9. Version 5-Form Field - Add Value POST https://{{domain}}/api/v5/objects/form-fields/:id/do/addValue

10. Version 5-Form Field - Add Dependent POST https://{{domain}}/api/v5/objects/form-fields/:id/do/addDependent