Prospects - mneedham91/PyPardot4 GitHub Wiki

The Prospects class queries and uses Pardot prospects.

If you initialize with p = PardotAPI(), you access the Accounts class with p.prospects

Methods

  • assign_by_fid Assigns or reassigns the prospect specified by fid to a specified Pardot user or group. fid must be a valid CRM FID. One (and only one) of the following parameters must be provided to identify the target user or group: user_email, user_id, or group_id. Returns an updated version of the prospect.

  • assign_by_id Assigns or reassigns the prospect specified by id to a specified Pardot user or group. One (and only one) of the following parameters must be provided to identify the target user or group: user_email, user_id, or group_id. Returns an updated version of the prospect.

  • batchCreate Creates new prospects using the provided data in either XML or JSON. See Endpoints for Batch Processing

  • batchUpdate Updates prospects using the provided data in either XML or JSON. See Endpoints for Batch Processing

  • batchUpsert Updates prospects using the provided in either XML or JSON. See Endpoints for Batch Processing

  • create Creates a new prospect using the specified data. email must be a unique email address. May optionally include fid, a crm fid. Returns the new prospect.

  • delete_by_fid Deletes the prospect specified by fid. Returns True if operation was successful.

  • delete_by_id Deletes the prospect specified by id. Returns True if operation was successful.

  • query Returns the prospects matching the specified criteria parameters.

  • read_by_email Returns data for the prospect specified by email, including campaign assignment, profile criteria matching statuses, associated visitor activities, email list subscriptions, and custom field data. email is the email address of the target prospect.

  • read_by_id Returns data for the prospect specified by id, including campaign assignment, profile criteria matching statuses, associated visitor activities, email list subscriptions, and custom field data. id is the Pardot ID of the target prospect.

  • read_by_fid Returns data for the prospect specified by fid. fid must be a valid CRM FID. This data includes campaign assignment, profile criteria matching statuses, associated visitor activities, email list subscriptions, and custom field data. id is the Pardot ID of the target prospect.

  • read_field_by_fid Returns the value of the provided field specified by field_name for the prospect specified by fid.

  • read_field_by_id Returns the value of the provided field specified by field_name for the prospect specified by id.

  • unassign_by_fid Unassigns the prospect specified by fid. Returns an updated version of the prospect.

  • unassign_by_id Unassigns the prospect specified by id. Returns an updated version of the prospect.

  • upsert_by_email Updates the provided data for the prospect specified by email. If a prospect with the provided email address does not yet exist, a new prospect is created using the email value. Fields that are not updated by the request remain unchanged.

  • upsert_by_fid Updates the provided data for the prospect specified by fid. If an email value is provided, it is used to update the prospect's email address. If a prospect with the provided ID is not found, Pardot searches for a prospect identified by email. If a prospect with the provided email address does not yet exist, a new prospect is created using email value. Fields that are not updated by the request remain unchanged.

  • upsert_by_id Updates the provided data for the prospect specified by id. If an email value is provided, it is used to update the prospect's email address. If a prospect with the provided ID is not found, Pardot searches for a prospect identified by email. If a prospect with the provided email address does not yet exist, a new prospect is created using email value. Fields that are not updated by the request remain unchanged.

  • update_by_fid Updates the provided data for a prospect specified by fid, the Pardot crm fid of the prospect. Fields that are not updated by the request remain unchanged.

  • update_by_id Updates the provided data for a prospect specified by id, the Pardot ID of the prospect. Fields that are not updated by the request remain unchanged.

  • update_field_by_id Updates the provided field for the prospect specified by id. Returns the updated prospect.

  • update_field_by_fid Updates the provided field for the prospect specified by fid. Returns the updated prospect.

⚠️ **GitHub.com Fallback** ⚠️