Custom Redirect Object

Track links on your website or third-party site with Account Engagement’s custom redirects. For example, you can track a link on your Twitter page or a banner ad on a third-party site. When a user clicks a link, a corresponding activity is created on their profile. Learn about custom redirects in Salesforce Help.

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

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

Note

Supported Operations

Operation	Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/custom-redirects/<id>?<params>`	Marketing > Content > Custom Redirects > View
Create	`POST`	`https://pi.pardot.com/api/v5/objects/custom-redirects?<params>`	Marketing > Content > Custom Redirects > Create
Update	`PATCH`	`https://pi.pardot.com/api/v5/objects/custom-redirects/<id>?<params>`	Marketing > Content > Custom Redirects > Create
Delete	`DELETE`	`https://pi.pardot.com/api/v5/objects/custom-redirects/<id>`	Marketing > Content > Custom Redirects > Delete
Query	`GET`	`https://pi.pardot.com/api/v5/objects/custom-redirects?<params>`	Marketing > Content > Custom Redirects > View
Add Tag	`POST`	`https://pi.pardot.com/api/v5/objects/custom-redirects/<id>/do/addTag`	Marketing > Content > Custom Redirects > Create AND Marketing > Segmentation > Tags > Create
Remove Tag	`POST`	`https://pi.pardot.com/api/v5/objects/custom-redirects/<id>/do/removeTag`	Marketing > Content > Custom Redirects > Create AND Marketing > Segmentation > Tags > Create

Fields

Required Editable Fields

Field	Type	Description
`name`	String	Name of the object for identification in Account Engagement.
`campaignId`	Integer	Account Engagement Campaign related to this object.
`destinationUrl`	String	A fully qualified URL. The visitor who clicks the custom redirect will be directed to this location. E.g. `https://example.com/content.html`

Optional Editable Fields

Field	Type	Description
`folderId`	Integer	ID of the folder containing this object. Uses the asset type’s uncategorized folder if not specified on create.
`trackerDomainId`	Integer	ID of the tracker domain to use in the URL for this object. Uses the primary tracker domain for the account if not specified on create.
`vanityUrlPath`	String	Vanity URL path (excluding protocol and host). Must be unique for each tracker domain. E.g. `/my-link`. The value assumes empty (`/`) if not specified on create.

Optional Google Analytics Fields

The following fields are only available if a Google Analytics connector is present. For more information, see the Google Analytics documentation.

Field	Type	Description
`gaSource`	String	Campaign source
`gaMedium`	String	Campaign medium
`gaTerm`	String	Campaign keyword
`gaContent`	String	Campaign content
`gaCampaign`	String	Campaign ID

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the object.
`salesforceId`	String	Salesforce Id of the object.
`vanityUrl`	String	Fully qualified vanity URL. Includes tracker domain and vanityUrlPath. E.g. `https://mytracked.example.com/my-link`
`url`	String	Fully qualified tracked URL. Doesn’t include Vanity URL. E.g. `https://mytracked.example.com/l/386175/2023-03-30/rnctj`
`trackedUrl`	String	Fully qualified tracked URL if Vanity URL isn’t set, otherwise Vanity URL is returned.
`bitlyIsPersonalized`	Boolean	True if a custom Bitly URL was set.
`bitlyShortUrl`	String	If set, a fully qualified Bitly URL.
`isDeleted`	Boolean	True if the object is in the recycle bin in Account Engagement.
`createdAt`	DateTime	Creation time of the object.
`updatedAt`	DateTime	Last update time of the object.
`createdById`	Integer	ID of the user who created this object.
`updatedById`	Integer	ID of the user who last updated this object.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`updatedBy`	User	User object representing the uer who last updated this object. See documentation for User for fields.
`trackerDomain`	TrackerDomain	Tracker 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 will use the default tracker domain for the account.
`campaign`	Campaign	Campaign object representing the campaign that was set on Create. See documentation for Campaign for fields.
`folder`	Folder	JSON object representing the folder for this object. See documentation for Folder for fields.

Custom Redirect Create

A custom redirect POST request must have a JSON body with all required fields specified, as described in the Version 5 Overview.

Example request:

1POST /api/v5/objects/custom-redirects?fields=id,folderId,name,destinationUrl,campaignId,trackerDomainId,vanityUrlPath,vanityUrl,gaSource,gaMedium,gaTerm,gaContent,gaCampaign,createdAt,updatedAt,isDeleted,createdBy.username,updatedBy.username,trackerDomain.domain,campaign.name HTTP/1.1
2Host: pi.pardot.com
3Authorization: Bearer <access-token>
4
5{
6    "name": "Custom Redirect API",
7    "destinationUrl": "https://example.com/destination.html",
8    "campaignId": 1,
9    "trackerDomainId": 2,
10    "vanityUrlPath": "/an-example",
11    "gaTerm": "Search Term"
12}

Example response

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

1HTTP/1.1 201 Created
2Content-Type: application/json
3Location: https://pi.pardot.com/api/v5/objects/custom-redirects/8736?fields=id,folderId,name,destinationUrl,campaignId,trackerDomainId,vanityUrlPath,vanityUrl,gaSource,gaMedium,gaTerm,gaContent,gaCampaign,createdAt,updatedAt,isDeleted,createdBy.username,updatedBy.username,trackerDomain.domain,campaign.name
4
5{
6    "id": 8736,
7    "folderId": 22,
8    "name": "Custom Redirect API",
9    "destinationUrl": "https://example.com/destination.html",
10    "campaignId": 1,
11    "trackerDomainId": 2,
12    "vanityUrlPath": "/an-example",
13    "vanityUrl": "https://mycompany.com/an-example",
14    "gaSource": null,
15    "gaMedium": null,
16    "gaTerm": "Search Term",
17    "gaContent": null,
18    "gaCampaign": null,
19    "createdAt": "2020-10-01T10:19:51-04:00",
20    "updatedAt": "2020-10-01T10:19:51-04:00",
21    "isDeleted": false,
22    "createdBy": {
23        "username": "jsmith@mycompany.com"
24    },
25    "updatedBy": {
26        "username": "jsmith@mycompany.com"
27    },
28    "trackerDomain": {
29        "domain": "mycompany.com"
30    },
31    "campaign": {
32        "name": "Website Tracking"
33    }
34}

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

Custom Redirect Update

Updating a custom redirect follows the conventions described in the Version 5 Overview.

Custom Redirect Delete

Deleting a custom redirect follows the conventions described in the Version 5 Overview.

Custom Redirect Query

Retrieving a collection of custom redirects 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:

1GET /api/v5/objects/custom-redirects?fields=id,folderId,name,destinationUrl,campaignId,trackerDomainId,vanityUrlPath,vanityUrl,gaSource,gaMedium,gaTerm,gaContent,gaCampaign,createdAt,updatedAt,isDeleted,createdBy.username,updatedBy.username,trackerDomain.domain,campaign.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": 8736,
7            "folderId": 22,
8            "name": "Custom Redirect API",
9            "destinationUrl": "https://example.com/destination.html",
10            "campaignId": 1,
11            "trackerDomainId": 2,
12            "vanityUrlPath": "/an-example",
13            "vanityUrl": "https://mycompany.com/an-example",
14            "gaSource": null,
15            "gaMedium": null,
16            "gaTerm": "Search Term",
17            "gaContent": null,
18            "gaCampaign": null,
19            "createdAt": "2020-10-01T10:19:51-04:00",
20            "updatedAt": "2020-10-01T10:19:51-04:00",
21            "isDeleted": false,
22            "createdBy": {
23                "username": "jsmith@mycompany.com"
24            },
25            "updatedBy": {
26                "username": "jsmith@mycompany.com"
27            },
28            "trackerDomain": {
29                "domain": "mycompany.com"
30            },
31            "campaign": {
32                "name": "Website Tracking"
33            }
34        }
35    ]
36}

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 redirects where ID is equal to the given integer value.
`idList`	Returns any custom redirects where ID is included in the given list of values.
`idGreaterThan`	Returns any custom redirects where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any custom redirects where ID is greater than or equal to the specified value.
`idLessThan`	Returns any custom redirects where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any custom redirects where ID is less than or equal to the specified value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example request:

1GET /api/v5/objects/custom-redirects?fields=id,name&orderBy=id desc&idGreaterThan=150&idLessThan=200
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": 168,
7            "name": "Spring Flyer Custom Redirect"
8        },
9        {
10            "id": 151,
11            "name": "Winter Flyer Custom Redirect"
12        }
13    ]
14}

Add Tag

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

Example Request

1POST https://pi.pardot.com/api/v5/objects/custom-redirect/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-redirect",
9    "tagId": 100
10}

Remove Tag

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

Example Request

1POST `https://pi.pardot.com/api/v5/objects/custom-redirect/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.