Newer Version Available

This content describes an older version of this product. View Latest

PardotTenant

Represents an Account Engagement business unit. This object is available in API version 56.0 and later.

Pardot is now known as Marketing Cloud Account Engagement. We wish we could snap our fingers to update the name everywhere, but you can expect to see the previous name in a few places, including API names and developer resources.

Note

Use available SOAP calls to create new business units, and query and update information in existing business units.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

create(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

GET, HEAD, PATCH, POST, Query

Special Access Rules

PardotTenant is available to customers with any Account Engagement edition.

Fields

Field Details
CreationStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The operational status of the business unit managed by Account Engagement.
Possible values are:
  • Backfilled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Deprovisioned
  • Deprovisioning
  • Error
  • Updated
  • Updating
The default value is Creating.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Universally unique identifier for this object. If an object does not provide a value for this field on INSERT, a value will be auto-generated for it.
InitialPardotAdminId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The Salesforce user who set up the business unit.
This field is a relationship field.
Relationship Name
InitialPardotAdmin
Relationship Type
Lookup
Refers To
User
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the business unit.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the Account Engagement business unit. This field syncs with the PardotTenantName field.
PardotTenantId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The numerical identifier for the business unit.
PardotTenantName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the Account Engagement business unit. This field syncs with the MasterLabel field.
PardotTenantStatusCode
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The operational status of the business unit.
Possible values are:
  • InsufficientLicenseLimits
  • InvalidRequest
  • PardotAccountNotFound
  • UnknownError
  • UsernameCollision

Usage

To create an Account Engagement business unit, set a valid user ID for the InitialPardotAdminID field and a value for PardotTenantName. If you have multiple business units, the PardotTenantName value must be unique.

To verify the status of a business unit, query the PardotTenantID. A return value of CREATING means the business unit is being created. A return value of CREATED means the business unit has been created.

Update capabilities are limited to changing the PardotTenantName field and deleting a business unit if an error occurs upon creation. To delete the PardotTenant, one of these scenarios must be true:
  • The CreationStatus has a value of ERROR.
  • The CreationStatus has a value of CREATING, UPDATING, or DELETING, and the system hasn’t updated the tenant in the last hour.