API Docs / Schemas / EmailBroadcastFilterDto

EmailBroadcastFilterDto

Filter criteria for selecting which clients receive an email broadcast.
Same wire shape as the CSV export filter — matches the filters on the client list endpoint.
If the filter is omitted entirely, only AdditionalClientCodes are included (pure hand-picked list).
An empty filter object selects all clients.

Properties

Name Type Description
managerCodesarray of string

Filter clients by their assigned manager's code(s).

Filter clients by their assigned manager's code(s).

partnerCodesarray of string

Filter clients by their assigned partner's code(s).

Filter clients by their assigned partner's code(s).

associateCodesarray of string

Filter clients by their assigned associate's code(s).

Filter clients by their assigned associate's code(s).

statusesarray of enum

Filter clients by status(es).
Values: Active, Inactive, Prospect, LostProspect

Active Inactive Prospect LostProspect

Filter clients by status(es).
Values: Active, Inactive, Prospect, LostProspect

Active Inactive Prospect LostProspect

typesarray of enum

Filter clients by their organization type(s).

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association

Filter clients by their organization type(s).

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association

serviceCodesarray of string

Filter clients by billable service code(s) they have assigned.

Filter clients by billable service code(s) they have assigned.

packageCodesarray of string

Filter clients by service package code(s) they have assigned.

Filter clients by service package code(s) they have assigned.

teamCodesarray of string

Filter clients by their assigned team's code(s).

Filter clients by their assigned team's code(s).

serviceStageCodesarray of string

Filter clients by service stage composite codes (format: "serviceCode:stageCode").

Filter clients by service stage composite codes (format: "serviceCode:stageCode").

searchstring

Search across client code, name and internal reference.
Minimum 3 characters.

Search across client code, name and internal reference.
Minimum 3 characters.

JSON Example

{
  "managerCodes": [
    "string"
  ],
  "partnerCodes": [
    "string"
  ],
  "associateCodes": [
    "string"
  ],
  "statuses": [
    "Active"
  ],
  "types": [
    "PrivateLimitedCompany"
  ]
}

Contained in Schemas