Skip to end of banner
Go to start of banner

POST v2/EviNotice/Batches

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

HTTP Method: POST

Description:

This endpoint allows the creation of a request for a bulk email in EviNotice. 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.

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/EviNotice/Batches
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "Description": "Bulk invitation mailing"    
}

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 or SMS.

  • The system automatically checks if the user has enough credits for the email and adjusts the credit based on the messages finally processed.

  • No labels