/
POST v2/EviSMS/Batches

POST v2/EviSMS/Batches

Owned by Jose Luis Lozano
Last updated: Jan 21, 2025
1 min read

HTTP Method: POST

Description:

This endpoint allows the creation of a request for a bulk SMS in EviSMS. Upon receiving the initial data for the bulk SMS 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 SMS.

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/EviSMS/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 SMS.

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