POST v2/EviMail/Batches

HTTP Method: `POST`

Description:

This endpoint allows the creation of a request for a bulk email in EviMail. Upon receiving the initial data for the bulk email request, the system returns a BatchId that identifies the request. This BatchId will be used in other endpoints to specify recipients, attachments, and finalize the configuration before processing the sending.

Input Parameters

Description (string): Description of the bulk email.
IssuerName (string): Name of the sender for the bulk email.
CostCentre (string, optional): Cost center for billing grouping.
AffidavitKinds (IEnumerable<AffidavitKind>, optional): List of affidavit types to be generated.
Language (string, optional): Language for the email.
AffidavitLanguage (string, optional): Language for the generated affidavits.
OnlineRetentionPeriod (int, optional): Years of online custody for the evidence.
LtaStorage (bool, optional): Indicates if the evidence will be stored in LTA storage.
PushNotificationUrl (string, optional): URL to receive status change notifications of the evidence.
PushNotificationFilter (PushNotificationsFilterCollection, optional): List of push notifications expected by the client.
PushNotificationExtraData (string, optional): Additional data that the sender wishes to include in each push notification.
CommitmentOptions (EviMailCommitmentOptionsMode, optional): Allows configuration of whether the recipient can accept/reject the message.
- Disabled
- Accept:
- Reject:
- AcceptOrReject:
CommitmentCommentsAllowed (bool, optional): Allows the recipient to add comments upon accepting/rejecting.
RejectReasons (IEnumerable<string>, optional): Specifies a list of possible reasons for rejecting the email.
AcceptReasons (IEnumerable<string>, optional): Specifies a list of possible reasons for accepting the email.
RequireRejectReason (bool, optional): Requires specifying a reason for rejection.
RequireAcceptReason (bool, optional): Requires specifying a reason for acceptance.
HideBanners (bool, optional): Hides certification banners in the email.
BatchPushNotificationUrl (string, optional): URL to receive notifications once the process is complete.

Output Parameters

BatchId (Guid): Unique identifier of the created Batch. This ID should be used in subsequent calls to complete the bulk email configuration.

Request Example

POST /v2/EviMail/Batches
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "Description": "Bulk invitation mailing",
    "IssuerName": "Marketing Team",    
    "CostCentre": "Marketing",
    "AffidavitKinds": ["Delivery"],
    "Language": "en",
    "AffidavitLanguage": "en",
    "OnlineRetentionPeriod": 1,
    "LtaStorage": false,
    "PushNotificationUrl": "https://client.callback.url/notifications",
    "PushNotificationFilter": ["Delivered", "Submitted"],
    "PushNotificationExtraData": "Spring Campaign",
    "CommitmentOptions": "AcceptOrReject",
    "CommitmentCommentsAllowed": true,
    "RejectReasons": ["Content not relevant", "Incorrect recipient"],
    "AcceptReasons": ["Confirmed interest", "Interested in details"],
    "RequireRejectReason": false,
    "RequireAcceptReason": false,
    "HideBanners": true,
    "BatchPushNotificationUrl": "https://client.callback.url/batch-notifications"   
}

Response Example

json

{ "BatchId": "a5b1f3f2-5c73-4b6d-88b9-73d81a9c5f8e" }

Notes

This BatchId should be stored for use in subsequent endpoints that allow adding recipients, attachments, and finalizing the configuration for the bulk email.
The system automatically checks if the user has enough credits for the email and adjusts the credit based on the messages finally processed.