Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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

...