Transitioning to V5?
Version 5 works with both Allow Multiple Prospects with Same Email Address (AMPSEA) and non-AMPSEA business units.
Determine if your Account Engagement business unit has AMPSEA enabled. Learn more in Help
Update your requests to use the Version 5 path. For example:
Before:
Version 3:
Version 4:
After:
- Create: Prospects can be created with a referenced
emailaddress. If AMPSEA is enabled and you call the create API with the same email address multiple times, each call creates a prospect. - Read/Query: When making a read query, querying by
emailreturns all prospects that share that email address. Querying by Account Engagementidonly returns the one matching prospect. - Update: In version 5, an update must specify a prospect by id. In version 3 it was possible to specify a prospect by email address.
- upsertLatestByEmail: UpsertLatestByEmail will find the most recently updated prospect by the
emailsupplied and upsert that record. If a record with that email does not exist, one will be created. See Upserting Prospects for more details. - Delete: Delete query must be referenced by Account Engagement
id.
See the Prospect Object documentation
- Assign: Assigning must be done by
prospectId.
See the Visitor Object documentation.
V5 introduces the Salesforce Connector API which allows for managing the status of your business unit's Salesforce Connector status.
V5 introduces bulk actions which allows for mass deleting records asynchronously. For example, up to 100,000 prospects can be deleted in one request.
See the Bulk Actions documentation.
The V5 API has updated the forms API has been expanded to include several new features including creating forms, reordering form fields, adding/removing tags, and copying to CMS.
The V5 API has also added endpoints for Form Fields, Form Handlers, and Form Handler Fields. See the linked documentation for more details.
V5 adds the Visitor Page View API which allows for Read and Query of Visitor Page Views.