Skip to content

List Memberships

Matt Needham edited this page Aug 15, 2017 · 2 revisions

The List Memberships class queries and uses Pardot list memberships.

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

Methods

  • create Creates a new list membership using the specified data. list_id is the Pardot list ID of the target list and prospect_id is the Pardot prospect ID of the target prospect. Opting out prospect from list may also be added with this request.

  • delete Deletes the list membership specified by list_id and prospect_id. list_id is the Pardot list ID of the list and prospect_id is the Pardot prospect ID of the prospect for the target list membership. Returns HTTP 204 No Content on success.

  • delete_by_id Deletes the list membership specified by id, the Pardot ID of the target list membership. Returns HTTP 204 No Content on success.

  • query Returns the list memberships matching the specified criteria parameters.

  • read Returns the data for the list membership specified by list_id and prospect_id. list_id is the Pardot list ID of the list and prospect_id is the Pardot prospect ID of the prospect for the target list membership.

  • read_by_id Returns the data for the list membership specified by id, the Pardot ID of the target list membership.

  • update Updates the provided data for a list membership specified by list_id and prospect_id. list_id is the Pardot list ID of the list and prospect_id is the Pardot prospect ID of the prospect for the target list membership. Fields that are not updated by the request remain unchanged.

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

Clone this wiki locally