Files

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

Supported Operations

Fields

Required Editable Fields

None.

Optional Editable Fields

Read-Only Fields

File Creation

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

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

Example request:

POST /api/v5/objects/files?fields=id,name,url,createdBy.id,createdBy.username HTTP/1.1
Host: pi.pardot.com
Authorization: Bearer <access-token>
Content-Type: multipart/form-data; boundary=----boundary-marker

----boundary-marker
Content-Disposition: form-data; name="file"; filename="conference_venues.pdf"

<file-data>
----boundary-marker
Content-Disposition: form-data; name="input"

{
    "name": "Conference Venues",
    "campaignId": 72836
}
----boundary-marker

Example response:

This example does not show all the headers, and whitespace has been added to make it easier to read.

HTTP/1.1 201 Created
Content-Type: application/json
Location: https://pi.pardot.com/api/v5/objects/files/8736?fields=id,name,url,createdBy.id,createdBy.username

{
    "id": 8736,
    "name": "Conference Venues",
    "url": "https://go.pardot.com/<generated-path-components>/conference_venues.pdf",
    "createdBy": {
        "id": 457,
        "username": "jsmith@mycompany.com"
    }
}

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 do not specify name, the name of the File is not changed. Note: This 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 cannot 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 is not 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:

GET /api/v5/objects/files?fields=id,name,url,createdBy.id,createdBy.username&orderBy=id
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 8736,
            "name": "Conference Venues",
            "url": "https://go.pardot.com/<generated-path-components>/conference_venues.pdf",
            "createdBy": {
                "id": 457,
                "username": "jsmith@mycompany.com"
            }
        }
    ]
}

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.

Example request:

GET /api/v5/objects/files?fields=id,name&orderBy=id desc&idGreaterThan=150&idLessThan=200
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 168,
            "name": "Spring Flyer PDF"
        },
        {
            "id": 151,
            "name": "Winter Flyer PDF"
        }
    ]
}