Correspondence

📄️ Search staging patients

Searches patients within a campaign staging instance, with optional pagination and filtering.

📄️ Search correspondences

Searches sent correspondence records within a campaign instance, with optional pagination and filtering.

📄️ Save correspondence age ranges

Creates or updates the correspondence age ranges configuration.

📄️ Get correspondence age ranges

Returns all configured correspondence age ranges.

📄️ Resolve recipient contacts

Resolves the available contacts and matching templates for the specified patient recipients and template type.

📄️ Resolve bookmarks

Resolves correspondence template bookmarks for the specified patients and bookmark groups.

📄️ Produce campaign correspondence

Produces the correspondence for the specified campaign round and returns the updated campaign dashboard state.

📄️ Print campaign documents

Generates printable documents for the specified patient correspondence entries.

📄️ Print campaign correspondence

Generates a printable file for the specified campaign round correspondence.

📄️ Preprocess campaign by ID

Triggers preprocessing for the specified campaign.

📄️ Get hub templates

Returns all hub correspondence templates available to the current session.

📄️ Get hub template blocks

Returns hub correspondence template blocks, optionally filtered by template type and active status.

📄️ Get CRM gateway URL

Checks the configured CRM gateway URL and returns the current campaign dashboard state.

📄️ Get correspondence template

Returns the full details of a correspondence template including its content.

📄️ Delete correspondence template

Deletes the correspondence template with the specified identifier.

📄️ Get correspondence templates

Returns all correspondence templates available to the current session.

📄️ Create correspondence template

Creates a new correspondence template.

📄️ Get correspondence templates by template type

Returns all correspondence templates matching the specified template type.

📄️ Get correspondence templates by channel type

Returns all correspondence templates matching the specified communication channel type.

📄️ Get correspondence tags

Returns correspondence tags, optionally filtered by tag type and campaign type.

📄️ Get correspondence program

Returns the full details of a correspondence program including its communication rounds and campaigns.

📄️ Delete correspondence program

Deletes the correspondence program with the specified identifier.

📄️ Get correspondence programs

Returns all correspondence programs available to the current session.

📄️ Create correspondence program

Creates a new correspondence program.

📄️ Get campaign dashboard

Returns correspondence campaigns and their current status for the dashboard.

📄️ Get running campaign details

Returns the detailed round and instance breakdown for a running correspondence campaign.

📄️ Execute campaign selection

Runs the patient selection process for the specified campaign.

📄️ Execute campaign selection by type (deprecated)

Runs the patient selection process for all campaigns of the specified type.

📄️ Execute campaign selection in background

Runs the patient selection process for all campaigns of the specified type in the background.

📄️ Execute campaign preprocess

Preprocesses the specified campaign round and returns the updated campaign dashboard state.

📄️ Complete print correspondence

Marks the print step of a campaign round as completed and returns the updated campaign dashboard state.