Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jose Luis Lozano

Jose Luis Lozano

Saved on

Key

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

HTTP Method: DELETE

Description:

This endpoint allows the deletion of all previously added recipients for a specific bulk email/SMS batch. Once called, all recipients associated with the batchid will be removed.

Input Parameters

  • No input parameters required.

Output Parameters

  • No output parameters.

    • The endpoint will only return an HTTP status code indicating the result of the operation.

Request Example

Code Block
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

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

Response Example

The endpoint will return an HTTP status code:

  • 200 OK if the recipients were successfully deleted.

  • 404 Not Found if the specified batchid does not exist or if there are no recipients to delete.

Notes

  • The batchid in the URL is the unique identifier of the batch created in the initial request (v2/EviNotice/Batches).

  • This action is irreversible; once all recipients are deleted, they cannot be recovered.