Skip to main content
POST
Preview existing recipient tags before replacement

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

entity_ids
required
program_id

Current program selection or all programs.

Example:

42

query
string

Current worksheet search for all selection.

Example:

"Jane"

savedFilterId
integer
Example:

42

filterGroups
object[]

Current worksheet filter groups passed to filtered all selection.

fields
string[]

Current worksheet selected fields; also triggers filtered sponsorship resolution.

filter

True for true, integer1 or case-insensitive1/true/on/yes; otherwise false.

Example:

true

status
enum<string>
Available options:
current,
due
Example:

"current"

values
object

Response

Operation result.

data
object

Existing selected tags and occurrence counts, descending count then case-insensitive name. Proposed replacement values are not applied.