Type Alias ListBlocklistsRequest

ListBlocklistsRequest: {
    custom?: boolean;
    domainId: string;
    email?: string;
    orderBy?: ListBlocklistsRequestOrderBy;
    page?: number;
    pageSize?: number;
    region?: Region;
    type?: BlocklistType;
}

Type declaration

  • Optionalcustom?: boolean

    (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).

  • domainId: string

    (Optional) Filter by a domain ID.

  • Optionalemail?: string

    (Optional) Filter by an email address.

  • OptionalorderBy?: ListBlocklistsRequestOrderBy

    (Optional) List blocklist corresponding to specific criteria.

  • Optionalpage?: number

    (Optional) Requested page number. Value must be greater or equal to 1.

  • OptionalpageSize?: number

    (Optional) Requested page size. Value must be between 1 and 100.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionaltype?: BlocklistType

    (Optional) Filter by a blocklist type.

Settings