Custom Field Object

Use custom fields to capture and track more data about your prospects. You can use custom fields in forms and sync the Account Engagement fields with Salesforce fields. Learn more about Account Engagement fields in Salesforce Help.

The API to access the Custom Field object follows the conventions described in Version 5 Overview.

Supported Operations

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/custom-fields/<id>?<params>`	Prospect > Prospects > Configure Fields
Create	`POST`	`https://pi.pardot.com/api/v5/objects/custom-fields?<params>`	Prospect > Prospects > Configure Fields
Update	`PATCH`	`https://pi.pardot.com/api/v5/objects/custom-fields/<id>?<params>`	Prospect > Prospects > Configure Fields
Delete	`DELETE`	`https://pi.pardot.com/api/v5/objects/custom-fields/<id>`	Prospect > Prospects > Configure Fields
Query	`GET`	`https://pi.pardot.com/api/v5/objects/custom-fields?<params>`	Prospect > Prospects > Configure Fields
Add Tag	`POST`	`https://pi.pardot.com/api/v5/objects/custom-fields/<id>/do/addTag`	Prospect > Prospects > Configure Fields AND Marketing > Segmentation > Tags > Create
Remove Tag	`POST`	`https://pi.pardot.com/api/v5/objects/custom-fields/<id>/do/removeTag`	Prospect > Prospects > Configure Fields AND Marketing > Segmentation > Tags > Create

Fields

Required Editable Fields

Field	Type	Description
`name`	String	Name of the object for identification in Account Engagement.
`fieldId`	String	User-defined ID of the object.
`type`	String	Possible values: Text, “Radio Button”, Checkbox, Dropdown, Textarea, Multi-Select, Hidden, Number, Date, “CRM User”

Optional Editable Fields

Field	Type	Description
`isRecordMultipleResponses`	Boolean	True if it records multiple responses, false otherwise.
`salesforceId`	String	Salesforce Id of the object.
`isUseValues`	Boolean	True if values are used false otherwise.
`valuesPrefill`	String	Write-Only field on create operation. Possible values: Countries, “Country Codes”, “US States”, “US State Codes”, “Canadian Provinces”, “Canadian Province Codes”, “US States and Canadian Provinces”, “US State and Canadian Province Codes”, “Japanese Prefectures”, “Japanese Prefecture Codes”
`isRequired`	Boolean	True if the custom field is required.

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of this object.
`isAnalyticsSynced`	Boolean	True if the object is synced to Analytics.
`createdAt`	DateTime	Creation time of this object.
`updatedAt`	DateTime	Last updated time for the object.
`createdById`	Integer	ID of the user who created the object.
`updatedById`	Integer	ID of the user who last updated the object.
`createdBy`	User	User object representing the user who created the object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated the object. See documentation for User for fields.

Custom Field Create

Create a custom field following the conventions described in the Version 5 Overview.

Example Request

1GPOST /api/v5/objects/custom-fields?fields=id, name, fieldId, apiFieldId, type, isRecordMultipleResponses, salesforceId, isUseValues, createdById,, createdAt,
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4
5{
6	"name":"My Custom Field",
7	"fieldId": "myCustomField",
8	"type":"text"
9}

Example Response

1{
2  "id": 1000,
3  "apiFieldId": "myCustomField__c",
4  "createdAt": "2021-12-13T14:31:39-08:00",
5  "createdById": 2479182,
6  "fieldId": "myCustomField",
7  "isAnalyticsSynced": false,
8  "isRecordMultipleResponses": false,
9  "isUseValues": false,
10  "name": "My Custom Field",
11  "salesforceId": null,
12  "type": "text"
13}

Custom Field Read

Retrieve a single custom field object following the conventions described in the Version 5 Overview.

Example Request

1GET /api/v5/objects/custom-fields/101?fields=id,name,fieldId
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example Response

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 232130,
5    "name": "Custom Field",
6    "fieldId": "custom_field"
7}

Custom Field Update

Update a single custom field object following the conventions described in the Version 5 Overview.

Example Request

1PATCH /api/v5/objects/custom-fields/1000?fields=id, name, fieldId, apiFieldId, type, updatedById, updatedAt
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4
5{
6	"name":"My Custom Field Updated",
7	"fieldId": "updatedCustomField"
8}

Example Response

1{
2  "id": 1000,
3  "apiFieldId": "updatedCustomField__c",
4  "fieldId": "updatedCustomField",
5  "name": "My Custom Field Update",
6  "type": "text",
7  "updatedAt": "2021-12-13T14:47:26-08:00",
8  "updatedById": 2479182
9}

Custom Field Delete

Delete a custom field object following the conventions described in the Version 5 Overview.

Example Request

1DELETE /api/v5/objects/custom-fields/44503Host: pi.pardot.com
2Authorization: Bearer <access-token>

Example Response

204 No Content

Custom Field Query

Retrieving a collection of custom fields 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
createdAt
updatedAt

Example Request

1GET /api/v5/objects/custom-fields?fields=id,name&orderBy=id
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example Response

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 101,
7            "name": "My Custom Field"
8        }
9    ]
10}

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.

Parameter	Description
`id`	Returns any custom fields where ID is equal to the given integer value.
`idList`	Returns any custom fields where ID is included in the given list of values.
`idGreaterThan`	Returns any custom fields where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any custom fields where ID is greater than or equal to the specified value.
`idLessThan`	Returns any custom fields where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any custom fields where ID is less than or equal to the specified value.
`name`	Returns any custom fields where Name is equal to the given string value.
`createdAt`	Returns any custom fields where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any custom fields where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any custom fields where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any custom fields where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any custom fields where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any custom fields where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any custom fields where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any custom fields where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any custom fields where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any custom fields where UpdatedAt is before or equal to the given datetime value.

Example Request

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

Example Response

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 283,
7            "name": "Custom Field 1"
8        },
9        {
10            "id": 282,
11            "name": "Custom Field 2"
12        },
13        {
14            "id": 239,
15            "name": "Custom Field 3"
16        },
17        {
18            "id": 202,
19            "name": "Custom Field 4"
20        }
21    ]
22}

Add Tag

Adds a Tag to the Custom Field object, which creates a TaggedObject.

Example Request

1POST https://pi.pardot.com/api/v5/objects/custom-fields/1000/do/addTag
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json
5
6{
7  "tagId": 100
8}

Example Response

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 610,
5    "createdAt": "2024-09-23T18:26:49-04:00",
6    "createdById": 250,
7    "objectId": 1000,
8    "objectType": "custom-field",
9    "tagId": 100
10}

Remove Tag

Remove a tag from a Custom Field object. When you remove a tag, the associated TaggedObject record is deleted.

Example Request

1POST https://pi.pardot.com/api/v5/objects/custom-fields/1000/do/removeTag
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4Content-Type: application/json
5
6{
7  "tagId": 100
8}

Example Response

Returns code 204 no content.