contactFilter

Name Type Required Description
type filterType Required if more than one filter is being defined. Defaults to AND if no type is specified. Used to define multiple filters.
email stringValue[] No Allows filtering of contacts based on matching email addresses.
mobileNumber stringValue[] No Allows filtering of contacts based on matching mobile numbers. The only supported filter operator for mobileNumber is EqualTo. If you use a different filter operator, you will still see results returned for the EqualTo operator.
id string[] No Allows filtering of contacts based on id. You can obtain the id for a contact by calling readContacts, or by looking at the footer when viewing the overview page for an individual contact in the application.
status string[] No Allows filtering of contacts based on a status, including active, onboarding, bounce, unsub, unconfirmed, and transactional.
created dateValue[] No Allows filtering of contacts based on criteria involving the creation date and time of the contact.
modified dateValue[] No Allows filtering of contacts based on criteria involving the last modification date and time of the contact.
listId string[] No Allows filtering of contacts based on an id of a list they belong to.
segmentId string[] No Allows filtering of contacts based on an id of a segment they belong to.
SMSKeywordID string[] No Allows filtering of contacts based on an id of an SMS keyword they are subscribed to.
msgPref string[] No Allows filtering of contacts based on their message format preference (html or text).
source string[] No Allows filtering on the source of the contact (manual, import, api, webform, or sforcereport.)
customSource stringValue[] No Allows you to filter on the custom source provided when the contact was imported or signed up.