PardotTenant Tooling API Reference
This Tooling API object represents an Account Engagement business unit. It’s 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 verbPOST
. - Query an existing account or business unit with the SOAP operations
query()
, andretrieve()
, or with the REST HTTP verbGET
. - Update an existing account or business unit with the SOAP operation
update()
, or with the REST HTTP verbPATCH
.
create()
query()
retrieve()
update()
GET
PATCH
POST
Field Name | Type | Description |
---|---|---|
CreationStatus | string | The operational status of the Account Engagement business unit. |
InitialPardotAdminId | reference | A reference to the Salesforce User ID associated with this Account Engagement business unit. |
PardotTenantId | string | The id of the Account Engagement business unit for this record. |
PardotTenantName | string | The name of the Account Engagement business unit. |
PardotTenantStatusCode | string | Metadata about the operational status of the Account Engagement business unit. The possible values are
|
Queue the creation of a PardotTenant record by setting:
- A valid User ID as the value for the field
InitialPardotAdminId
. - A unique value for
PardotTenantName
, if your organization supports multiple Account Engagement business units.
To find the status of an Account Engagement 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.
Under limited circumstances, updates are allowed to a PardotTenant record.
- Any change to the
PardotTenantName
field, which doubles as the company name of your business unit. - Removing a PardotTenant in an error state. To do so, change the
CreationStatus
of the record toDELETED
. One of the following must be true:- The PardotTenant record has a value of
ERROR
forCreationStatus
. - The PardotTenant record has a value of
CREATING
,UPDATING
, orDELETING
forCreationStatus
, and isn't modified within the past hour.
- The PardotTenant record has a value of
Outside the error state described in Update a PardotTenant, deleting a PardotTenant isn’t supported.
Error Message | Description |
---|---|
No Id on record to update | You didn’t provide the Id field in the request payload, so we can’t update a specific record. |
Attempted record update is not for a PardotTenant | The attempted record update isn’t for a PardotTenant. |
Could not find record to update for given Id | No record with the given ID could be found for update. |
Record was not in error state before attempted deletion | The record wasn’t in an error state before the attempted deletion. You can only delete a record that has a value of Error for CreationStatus . |
Record has a PardotTenantId configured and can not be deleted | The record has a PardotTenantId configured and can't be deleted. |