File Object

Upload images and other files to use in your Pardot emails, forms, and landing pages. Learn about files in Salesforce Help.

The API to access the Files object collection follows the conventions described in Version 5 Overview.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

File Resources

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/files/<id>?<params>Marketing > Content > Files > View ability
CreatePOSThttps://pi.pardot.com/api/v5/objects/files?<params>Marketing > Content > Files > Create/Edit ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/files/<id>?<params>Marketing > Content > Files > Create/Edit ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/files/<id>Marketing > Content > Files > Delete ability
QueryGEThttps://pi.pardot.com/api/v5/objects/files?<params>Marketing > Content > Files > View ability

Fields

Required Editable Fields

None.

Optional Editable Fields

FieldTypeDescription
nameStringName of the object for identification in Pardot. Uses the name of the file being uploaded if not specified on create.
folderIdIntegerID of the folder containing this object. Uses the asset type's uncategorized folder if not specified on create.
campaignIdIntegerPardot campaign related to this object. Uses null if not specified on create.
vanityUrlPathStringVanity URL path (excluding protocol and host). Must be unique for each tracker domain. For example /my-link. The value assumes empty (/) if not specified on create.
trackerDomainIdIntegerID of the TrackerDomain to use in the URL for this object. Uses the primary tracker domain for the account if not specified on create.

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
salesforceIdStringID of the Salesforce object representing this object.
urlStringURL where the downloadable file can be accessed.
sizeIntegerSize (in bytes) of the downloadable file.
bitlyIsPersonalizedBooleanTrue if the object has a bitly URL that is personalized.
bitlyShortUrlStringBitly URL if present.
vanityUrlStringVanity URL if present.
trackerDomainTrackerDomain objectJSON object representing the TrackerDomain to use in the URL for this object. See documentation for TrackerDomain for fields.
isTrackedBooleanTrue if downloads of this file are recorded as visitor activity.
createdAtDateTimeCreation time of the object.
updatedAtDateTimeLast update time of the object.
createdByIdIntegerID of the user who created this object.
updatedByIdIntegerID of the user who last updated this object.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
trackerDomainTrackerDomainTracker Domain object representing the tracker domain that was set on Create. See documentation for Tracker Domain for fields. A null value indicates that the object uses the default tracker domain for the account.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
folderFolderJSON object representing the folder for this object. See documentation for Folder for fields.

File Creation

A file creation POST request must be a multipart request as described in Version 5 Overview.

If the name field isn’t provided in the input body during creation, the filename of the uploaded file part is used for the name. A blank or null name can’t be explicitly included in the input for File creation.

Example request:

Example response:

This example doesn’t show all the headers, and whitespace has been added to make it easier to read.

The fields in the response body and Location header are the same as the fields specified on the example request.

File Update

A file update PATCH request can be a multipart request as described in Version 5 Overview. It can also be a simple request that has a JSON body with fields to update.

If you don’t specify name, the name of the File isn’t changed. This request is different from a File create POST request, which uses the filename of the uploaded file part as the default for name.

File Deletion

Deleting a file follows the conventions described in the Version 5 Overview. You can’t delete a file that is referenced by certain Pardot objects. For example, if you try to delete a file that is referenced by a dynamic list, a 204 Method Not Allowed status is returned and the file isn’t deleted.

File Query

Retrieving a collection of files follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

  • id

Example request:

Example response:

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any files where ID is equal to the given integer value.
idGreaterThanReturns any files where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any files where ID is greater than or equal to the specified value.
idLessThanReturns any files where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any files where ID is less than or equal to the specified value.

Example request:

Example response: