EviNotice Batch Sending

These endpoints are designed to manage the complete workflow of creating, configuring, scheduling, sending, and querying bulk email campaigns using the EviNotice system. The core functionality includes:

• Creating a EviNotice Batch

  • Endpoint: v2/EviNotice/Batches (POST)

  • Initiates a EviNotice batch by setting up basic details such as description, sender, and advanced options. It returns a unique BatchId used to identify the batch in subsequent operations.

• Configuring Batch Details

  • Body:

    • Endpoint: v2/EviNotice/Batches/{batchid}/Body (PUT)

      • Defines or updates the email's body. Supports the use of variables that are personalized for each recipient.

  • Attachments:

    • Endpoint: v2/EviNotice/Batches/{batchid}/Attachments (PUT)

      • Adds or replaces attachments for the batch in Base64 format. Previous attachments can be deleted by sending an empty array.

    • Endpoint: v2/EviNotice/Batches/{batchid}/Attachments (DELETE)

      • Removes all attachments associated with the batch.

  • Recipients:

    • Endpoint: v2/EviNotice/Batches/{batchid}/Recipients (POST)

      • Add recipients associated with the batch.

    • Endpoint: v2/EviNotice/Batches/{batchid}/Recipients (DELETE)

      • Removes all recipients associated with the batch.

  • Features:

    • Endpoint: v2/EviNotice/Batches/{batchid} (PATCH)

      • Add features associated with the EviNotice as Subject, AffidavitsKind, CertificationLevel, CommitmentOptions, etc..

• Scheduling and Batch State Management

  • Endpoint: v2/EviNotice/Batches/{batchid} (PATCH)

    • Allows scheduling the batch by setting a specific date and time (ScheduledDate) or reverting its state to "Draft." This marks the batch as ready to process or allows further adjustments.

• Querying and Managing Bulk Email Batches

  • Query a Specific Batch:

    • Endpoint: v2/EviNotice/Batches/{batchid} (GET)

    • Retrieves detailed information about a specific batch (subject, body, attachments, recipients, options, etc.). Optional parameters allow customization of the level of detail in the response.

  • List Available Batches:

    • Endpoint: v2/EviNotice/Batches (QUERY)

    • Lists all bulk email batches associated with a SiteId. Supports filtering by state, owner, and pagination to handle large datasets.

General Workflow

1. Start the Process: Create a batch via POST to obtain a BatchId.

2. Configuration: Customize the batch by adding a subject, body, attachments, and recipients as needed.

3. Scheduling: Define the sending date or adjust the batch state.

4. Query and Tracking: Query specific batch details or list all batches for a site, with filtering and pagination options to streamline management.

Notes

1. Billing Model Limitation:

   • This functionality is only available for sites configured with the "By Submission" billing model. Ensure the site's billing configuration supports this model before attempting to use these endpoints.

2. BatchId Dependency:

   • Most endpoints depend on the BatchId returned during the creation of a bulk email batch. Always store this identifier for subsequent operations.

3. Efficient Data Retrieval:

   • Use filtering options and pagination (via the Cursor parameter) to optimize performance and reduce response payload size.

4. Authentication Method: Basic Authentication

   Access to these endpoints requires Basic Authentication, which uses a combination of a username and password. The credentials must be encoded in Base64 and included in the Authorization header of each request.

Endpoints

POST v2/EviNotice/Batches

PUT v2/EviNotice/Batches/{batchid}/Body

POST v2/EviNotice/Batches/{batchid}/Recipients

DELETE v2/EviNotice/Batches/{batchid}/Recipients

PUT v2/EviNotice/ Batches/{batchid}/Attachments

PATCH v2/EviNotice/Batches/{batchid}

GET v2/EviNotice/Batches/{batchid}<?parameters>

QUERY v2/EviNotice/Batches

Examples

Examples collection