External Activity Object
External activity helps marketers use all of their prospect engagement to drive their marketing automations. There are two main components to external activity: an extension, which represents an integration, and the activity type, which is the type of engagement that can be submitted. For example, an extension can be an integration with Zoom, and the activity type can be registered for call and attended call.
The API to create External Activities follows the conventions described in Version 5 Overview.
| Operation | HTTP Verb | URL Format | Ability Requirements | Notes |
|---|---|---|---|---|
| Create | POST | https://pi.pardot.com/api/v5/external-activities | Prospect > External Activity > Create | Requires completion of External Activities implementation steps |
| Read | GET | https://pi.pardot.com/api/v5/external-activities/<id>?<params> | Prospect > External Activity > View | Requires completion of External Activities implementation steps |
| Query | GET | https://pi.pardot.com/api/v5/external-activities | Prospect > External Activity > View | Requires completion of External Activities implementation steps |
| Field | Type | Description |
|---|---|---|
extension | String | Name of the extension for this activity. |
type | String | The type of external activity for this record. It must be a value from one of the registered types in the account. |
email | String | The email address of the prospect related to this external activity. If there are multiple prospects with the specified email address, the one with the most recent activity is selected. |
value | String | Any string value related to this activity. This value isn’t checked and can be any value. The value can be 100 characters or less. |
| Field | Type | Description |
|---|---|---|
activityDate | Datetime | The date the external activity happened. It can be used by the user to backdate the activity. If not specified, then the current date is used. Must be in ISO8601 format with offset. Example: 2021-01-01T11:08:00+00:00 |
Create an external activity with the specified fields. If no value specified for activityDate the current time is used.
Retrieve a single external activity object following the conventions described in the Version 5 Overview.
Example Request
Example Response
Retrieving a collection of external activities follows the conventions described in Version 5 Overview.
Example Request
Example Response
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
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 external activity where id is equal to the given integer value. |
idList | Returns any external activity where id is included in the given list of values. |
idGreaterThan | Returns any external activity where id is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any external activity where id is greater than or equal to the specified value. |
idLessThan | Returns any external activity where id is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any external activity where id is less than or equal to the specified value. |
createdAt | Returns any external activity where createdAt is equal to the given datetime value. |
createdAtAfter | Returns any external activity where createdAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any external activity where createdAt is after or equal to the given datetime value. |
createdAtBefore | Returns any external activity where createdAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any external activity where createdAt is before or equal to the given datetime value. |
activityDate | Returns any external activity where activityDate is equal to the given datetime value. |
activityDateAfter | Returns any external activity where activityDate is after the given datetime value, non-inclusive. |
activityDateAfterOrEqualTo | Returns any external activity where activityDate is after or equal to the given datetime value. |
activityDateBefore | Returns any external activity where activityDate is before the given datetime value, non-inclusive. |
activityDateBeforeOrEqualTo | Returns any external activity where activityDate is before or equal to the given datetime value. |
The External Activity API is subject to its own limits governing daily requests, concurrent requests, and requests per minute. All External Activity API requests count against the limits defined for the External Activity API and don’t consume any standard Account Engagement API daily request or concurrency limits. All Account Engagement editions have the same limit of 200 requests per minute. Any request that exceeds this limit receives a 429 Too Many Requests response until the next minute.
| Edition | Daily External Activity Requests | Concurrent Requests | Requests Per Minute |
|---|---|---|---|
| Plus | 50,000 | 5 | 200 |
| Advanced | 100,000 | 5 | 200 |
| Premium | 100,000 | 5 | 200 |