pardot\_api

88 actions

Action

Description

Required scopes

Get Account

Retrieve the authenticated Pardot business unit's account-level settings and API usage (single record). This is the Pard...

List Campaigns

Query campaigns with filtering, ordering, and pagination

Get Campaign

Retrieve a single campaign by ID

Connect Salesforce Campaign

Link a Pardot campaign to a Salesforce campaign

Add Tag To Campaign

Apply a tag to a campaign. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From Campaign

Remove a tag from a campaign. The tag is identified by its numeric `tagId` — tag names are not accepted

List Custom Fields

Query prospect custom fields defined on the account

Get Custom Field

Retrieve a single custom field definition by ID

Create Custom Field

Create a new prospect custom field

Update Custom Field

Update an existing prospect custom field

Delete Custom Field

Soft-delete a custom field by ID

List Custom Redirects

Query trackable custom redirect links

Get Custom Redirect

Retrieve a single custom redirect by ID

Create Custom Redirect

Create a new trackable custom redirect link

Update Custom Redirect

Update an existing custom redirect

Delete Custom Redirect

Soft-delete a custom redirect by ID

List Dynamic Content

Query personalized content variations

Get Dynamic Content

Retrieve a single dynamic content record by ID

Create Dynamic Content

Create a new dynamic content record

Add Tag To Dynamic Content

Add a tag to a dynamic content record. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From Dynamic Content

Remove a tag from a dynamic content record. The tag is identified by its numeric `tagId` — tag names are not accepted

List One-to-One Emails

Query one-to-one emails sent to individual prospects

Get One-to-One Email

Retrieve a single one-to-one email by ID

Send One-to-One Email

Send a one-to-one email to a single prospect

List List Emails

Query bulk-email batches sent to recipient lists (one row per send batch). For single one-to-one emails sent to individu...

Get List Email

Retrieve a single list email by ID

Send List Email

Send a bulk email to one or more recipient lists

Get List Email Stats

Retrieve send statistics for a list email

List Email Templates

Query reusable email templates

Get Email Template

Retrieve a single email template by ID

List Engagement Programs

Query Engagement Studio automation programs

Get Engagement Program

Retrieve a single engagement studio program by ID

Download Engagement Program Structure

Download the encrypted base64-encoded program-structure file for an engagement program (used to clone or replicate the p...

List Files

Query Pardot hosted files

Get File

Retrieve a single file by ID

Upload File

Upload a hosted file to Pardot

Update File

Update metadata on an existing Pardot file

Delete File

Delete a file by ID

Add Tag To File

Add a tag to a Pardot file. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From File

Remove a tag from a Pardot file. The tag is identified by its numeric `tagId` — tag names are not accepted

List Folders

Query Pardot folders with filtering, ordering, and pagination

Get Folder

Retrieve a single Pardot folder by ID

List Folder Contents

Query folder-content mappings (which objects live in which folder)

Get Folder Contents Record

Retrieve a single folder-to-object junction record by its mapping ID (NOT a folder ID). Returns one row from the folder-...

List Forms

Query forms used for lead capture

Get Form

Retrieve a single form by ID

Create Form

Create a new lead-capture form. Requires `name`, `campaignId`, and `layoutTemplateId` (the ID of a Pardot layout templat...

Delete Form

Soft-delete a form by ID

List Landing Pages

Query Pardot landing pages

Get Landing Page

Retrieve a single landing page by ID

Create Landing Page

Create a new landing page. Requires `name` and `campaignId`. Supply either inline HTML in `content`, or a \`layoutTemplat...

Add Tag To Landing Page

Add a tag to a landing page. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From Landing Page

Remove a tag from a landing page. The tag is identified by its numeric `tagId` — tag names are not accepted

List List Memberships

Query the join records linking individual prospects to lists (i.e. which prospects are on which lists). Use to find memb...

Get List Membership

Retrieve a single list membership by ID

Add Prospect To List

Add a prospect to a list

Update List Membership

Update a list membership's opt-out status

Remove Prospect From List

Delete a list membership (remove a prospect from a list)

List Lists

Query the prospect mailing lists themselves (the list definitions used to group subscribers). For prospect-to-list join...

Get List

Retrieve a single prospect list by ID

Create List

Create a new prospect list

Update List

Update an existing prospect list

Delete List

Soft-delete a prospect list by ID

List Opportunities

Query opportunities synced from Salesforce

Get Opportunity

Retrieve a single opportunity by ID

List Prospects

Query prospect (lead/contact) records with filtering, ordering, and pagination.

Get Prospect

Retrieve a single prospect by ID with all custom fields

Create Prospect

Create a new prospect with the specified email and optional attributes

Update Prospect

Update an existing prospect's editable fields

Delete Prospect

Soft-delete a prospect by ID (moves to recycle bin)

Upsert Prospect By Email

Create or update a prospect using email as the unique key. Supply `matchEmail` and a nested `prospect` object with the f...

Undelete Prospect

Restore a deleted prospect from the recycle bin (prospect `id` is supplied in the request body, not the URL path)

Add Tag To Prospect

Apply a tag to a prospect. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From Prospect

Remove a tag from a prospect. The tag is identified by its numeric `tagId` — tag names are not accepted

List Tags

Query the tag definitions themselves (name + how many objects each tag is applied to). For finding which objects carry a...

Get Tag

Retrieve a single tag by ID

Create Tag

Create a new tag

Update Tag

Update an existing tag

Delete Tag

Delete a tag by ID

Merge Tags

Consolidate multiple tags into one. Path `id` is the target tag (kept); `tagIds` is the array of source tag IDs whose ob...

List Tagged Objects

Find which objects (prospects, files, campaigns, etc.) a given tag is applied to. Filter by `tagId` and `objectType`. Fo...

Get Tagged Object

Retrieve a single tagged-object record by ID

List Users

Query Pardot users with filtering, ordering, and pagination

Get User

Retrieve a single Pardot user by ID

Add Tag To User

Add a tag to a Pardot user. The tag is identified by its numeric `tagId` — tag names are not accepted

Remove Tag From User

Remove a tag from a Pardot user. The tag is identified by its numeric `tagId` — tag names are not accepted

List Visitor Activities

Query tracked visitor activities and engagement events

Get Visitor Activity

Retrieve a single visitor activity by ID