- https://developer.salesforce.com/docs/marketing/pardot/guide/object-field-reference.html#list-membership
- https://developer.salesforce.com/docs/marketing/pardot/guide/list-memberships-v3.html
- https://developer.salesforce.com/docs/marketing/pardot/guide/list-memberships-v4.html
Behaves the same in APIv3 and APIv4.
interface ListMembership {
id: number;
list_id: number;
prospect_id: number;
opted_out: boolean;
created_at: string;
updated_at: string;
}Retrieve a list of list memberships according to the parameters.
const queryResponse = await pardotClient.listMemberships.query(params);- params: ListMembershipQueryParams
interface ListMembershipQueryParams {
deleted?: boolean;
list_id?: number;
id_greater_than?: number;
id_less_than?: number;
created_after?: DateString;
created_before?: DateString;
updated_after?: DateString;
updated_before?: DateString;
limit?: number;
offset?: number;
sort_order?: 'ascending' | 'descending';
sort_by?: 'created_at' | 'id';
}A query response containing zero, one, or more list memberships.
interface ListMembershipQueryResponse {
result: {
total_results: number;
list_membership?: ListMembership | ListMembership[];
};
}Retrieve a list membership by list id and prospect id.
const listMembershipResponse = await pardotClient.listMemberships.read(listId, prospectId);- listId: List id (required)
- prospectId: Prospect id (required)
A response containing a list membership entry.
interface ListMembershipResponse {
list_membership: ListMembership;
}Retrieve a list membership by its id.
const listMembershipResponse = await pardotClient.listMemberships.readById(id);- id: List membership id (required)
A response containing a list membership.
interface ListMembershipResponse {
list_membership: ListMembership;
}Create a new list membership.
const listMembershipResponse = await pardotClient.listMemberships.create(
listId,
prospectId,
createData,
);- listId: List id (required)
- prospectId: Prospect id (required)
- createData: List membership object with all properties optional (required)
A response containing a list membership.
interface ListMembershipResponse {
list_membership: ListMembership;
}Update a list membership by list id and prospect id.
const listMembershipResponse = await pardotClient.listMemberships.update(
listId,
prospectid,
updateData,
);- listId: List id (required)
- prospectId: Prospect id (required)
- updateData: List membership object with all properties optional (required)
A response containing a list membership.
interface ListMembershipResponse {
list_membership: ListMembership;
}Update a list membership by its id.
const listMembershipResponse = await pardotClient.listMemberships.updateById(id, updateData);- id: List membership id (required)
- updateData: List membership object with all properties optional (required)
A response containing a list membership.
interface ListMembershipResponse {
list_membership: ListMembership;
}Delete a list membership by list id and prospect id.
await pardotClient.listMemberships.delete(listId, prospectId);- listId: List id (required)
- prospectId: Prospect id (required)
No return value.
Delete a list membership by its id.
await pardotClient.listMemberships.deleteById(id);- id: List membership id (required)
No return value.