deliveryGroupFilter

The deliveryGroupFilter can be used to select a subset of delivery groups. The readDeliveryGroups overview includes an example of using a filterOperator to limit the number of delivery groups returned.

Name Type Required Description
type filterType Required if more than one filter is being defined. Defaults to AND if no typeis specified. Used to define multiple filters.
name stringValue[] No The name associated with the delivery group.
Note: For readDeliveryGroups, only the EqualTo and StartsWith filterOperators are supported.
listByType string No Valid values are DELIVERIES, AUTOMATORS, or MESSAGEGROUPS. You need to pass in “listByType” in the filter section if you want to tell the API which arrays to return.
Note: listByType should only be used if you want data on specific types of items (messages, deliveries, automated message rules) added to a particular delivery group. When using listByType, you should always identify the specific delivery group whose items you want to read data from using deliveryGroupId.
deliveryGroupId string No The unique id assigned to a delivery group. This will return data for a delivery group that matches the specific id.
deliveryId string No The unique id assigned to a specific delivery. This will return data for all delivery groups containing this delivery.
messageGroupId string No The unique id assigned to a specific message group. This will return data for all delivery groups containing this message.
automatorId string No The unique id assigned to an automated message rule. This will return data for all delivery groups containing this automated message rule.