List Membership Object

A list is a group of prospects that you can use to send list emails or to feed engagement programs. Use list membership resources to add and remove prospects to your static email lists, and to learn which prospects belong to which lists. Learn more about list membership in Salesforce Help.

The API to access the List Membership object follows the conventions described in Version 5 Overview.

Operation	HTTP Verb	URL Format	Ability Requirements
Create	`POST`	`https://pi.pardot.com/api/v5/objects/list-memberships?<params>`	Marketing > Segmentation > Create AND Prospect > Prospects > Create ability
Read	`GET`	`https://pi.pardot.com/api/v5/objects/list-memberships/<id>?<params>`	Marketing > Segmentation > View AND Prospect > Prospects > View ability
Update	`PATCH`	`https://pi.pardot.com/api/v5/objects/list-memberships/<id>?<params>`	Marketing > Segmentation > Create AND Prospect > Prospects > Create ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/list-memberships?<params>`	Marketing > Segmentation > View AND Prospect > Prospects > View ability
Delete	`DELETE`	`https://pi.pardot.com/api/v5/objects/list-memberships/<id>`	Marketing > Segmentation > Delete AND Prospect > Prospects > Delete ability

Field	Type	Description
`id`	Integer	Account Engagement ID for this list membership.
`createdAt`	DateTime	The time that this list membership was created. Reported in API user's preferred timezone.
`updatedAt`	DateTime	The time that this list membership was last updated. Reported in API user's timezone.
`createdById`	Integer	ID of the user who created this list membership.
`updatedById`	Integer	ID of the user who last updated this list membership.
`isDeleted`	Boolean	When `true`, the list membership is in the Account Engagement recycle bin.
`prospect`	Prospect	Prospect object representing the prospect associated with the list membership. See documentation for Prospect for fields.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated this object. See documentation for User for fields.
`list`	List	List object representing the list associated with the list membership. See documentation for List for fields.

Field	Type	Description
`optedOut`	Boolean	When `true`, the prospect is unsubscribed from receiving emails from this list. You can opt out prospects, but you can't opt them back in.
`listId`	Integer	Account Engagement ID of the list for this membership
`prospectID`	Integer	Account Engagement ID of the prospect for this membership

Create a list membership following the conventions described in the Version 5 Overview.

Example Request

Example Response

Retrieve a single list membership following the conventions described in the Version 5 Overview.

Example Request

Example Response

Updating a list membership follows the conventions described in Version 5 Overview.

Example Request

Example Response

Deleting a list membership follows the conventions described in Version 5 Overview.

Example Request

Example Response

204 No Content

Retrieve a collection of list memberships following the conventions described in the Version 5 Overview.

id
createdAt
updatedAt
listId

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 list membership where ID is equal to the given integer value.
`idList`	Returns any list membership where ID is included in the given list of values.
`idGreaterThan`	Returns any list membership where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any list membership where ID is greater than or equal to the specified value.
`idLessThan`	Returns any list membership where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any list membership where ID is less than or equal to the specified value.
`createdAt`	Returns any list membership where CreatedAt is equal to the given datetime value.
`createdAtAfter`	Returns any list membership where CreatedAt is after the given datetime value, non-inclusive.
`createdAtAfterOrEqualTo`	Returns any list membership where CreatedAt is after or equal to the given datetime value.
`createdAtBefore`	Returns any list membership where CreatedAt is before the given datetime value, non-inclusive.
`createdAtBeforeOrEqualTo`	Returns any list membership where CreatedAt is before or equal to the given datetime value.
`updatedAt`	Returns any list membership where UpdatedAt is equal to the given datetime value.
`updatedAtAfter`	Returns any list membership where UpdatedAt is after the given datetime value, non-inclusive.
`updatedAtAfterOrEqualTo`	Returns any list membership where UpdatedAt is after or equal to the given datetime value.
`updatedAtBefore`	Returns any list membership where UpdatedAt is before the given datetime value, non-inclusive.
`updatedAtBeforeOrEqualTo`	Returns any list membership where UpdatedAt is before or equal to the given datetime value.
`listId`	Returns any list membership where listId is equal to the given integer value.
`listIdGreaterThan`	Returns any list membership where listId is greater than the specified value, non-inclusive.
`listIdGreaterThanOrEqualTo`	Returns any list membership where listId is greater than or equal to the specified value.
`listIdLessThan`	Returns any list membership where listId is less than the specified value, non-inclusive.
`listIdLessThanOrEqualTo`	Returns any list membership where listId is less than or equal to the specified value.
`prospectId`	Returns any list membership where prospectId is equal to the given integer value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example Request

Example Response