Pardot Tenant Tooling API Reference

The object described here represents a Pardot account, or business unit. It is available in API version 56.0 and later.

  • Queue a new account or business unit with the SOAP operation create(), or with the REST HTTP verb POST.
  • Query an existing account or business unit with the SOAP operations query(), and retrieve(), or with the REST HTTP verb GET.
  • Update an existing account or business unit with the SOAP operation update(), or with the REST HTTP verb PATCH.

Supported Soap Calls

  • create()
  • query()
  • retrieve()
  • update()

Supported REST HTTP Methods

  • GET
  • PATCH
  • POST

Fields

Field NameTypeDescription
CreationStatusstringThe operational status of the Pardot business unit.
InitialPardotAdminIdreferenceA reference to the Salesforce User Id associated with this Pardot business unit.
PardotTenantIdstringThe id of the Pardot business unit for this record.
PardotTenantNamestringThe name of the Pardot business unit.
PardotTenantStatusCodestringMetadata about the operational status of the Pardort business unit. The possible values are
  • InsufficientLicenseLimits
  • InvalidRequest
  • PardotAccountNotFound
  • UnknownError
  • UsernameCollision

Creating a Pardot Tenant

Queue the creation of a Pardot tenant record by setting:

  1. A valid User ID as the value for the field InitialPardotAdminId.
  2. A unique value for PardotTenantName, if your organization supports multiple Pardot business units.

Verifying the Status of a Pardot Tenant

To find the status of a Pardot business unit after its creation has been queued, query the account for a given Id. A value of CREATING in CreationStatus indicates that the creation process is in progress. A value of CREATED in CreationStatus indicates that the creation process is finished.

Updating a Pardot Tenant

Under limited circumstances, updates are allowed to a Pardot tenant record.

  • Any change to the PardotTenantName field, which doubles as the company name of your business unit.
  • Removing a Pardot tenant in an error state. This can be done by changing the CreationStatus of the record to DELETED. However, this requires either of the following:
    • The Pardot tenant record has a value of ERROR for CreationStatus.
    • The Pardot tenant record has a value of CREATING, UPDATING, or DELETING for CreationStatus, and has not been modified by the system in the past hour.

Deleting a Pardot Tenant

Outside the error state described in Updating a Pardot Tenant, deleting a Pardot tenant is not supported.

Error MessageDescription
No Id on record to updateYou did not provide the Id field in the request payload, so we cannot update a specific record.
Attempted record update is not for a PardotTenantThe attempted record update is not for a Pardot tenant.
Could not find record to update for given IdNo record with the given ID could be found for update.
Record was not in error state before attempted deletionThe record was not in an error state before the attempted deletion. You can only delete a record that has a value of Error for Creation Status.
Record has a PardotTenantId configured and can not be deletedThe record has a PardotTenantId configured and can't be deleted.