Cancel a message dispatch

DELETE /v1/api/dispatch/{dispatchId}
X api key

Allows cancellation of a scheduled message dispatch. A dispatch can only be cancelled up to 5 minutes before the scheduled date and time. Immediate dispatches cannot be cancelled.

Responses

  • 200

    Dispatch successfully cancelled

  • 422

    The dispatch cannot be cancelled because the scheduled time has passed or is within the allowed cancellation window of 5 minutes.

  • 401

    Unauthorized

  • 403

    Forbidden

  • 400

    Bad Request

  • 500

    Internal Server Error

DELETE /v1/api/dispatch/{dispatchId} 
curl \
 --request DELETE 'https://api.nifteem.com/v1/api/dispatch/{dispatchId}' \
 --header "X-API-Key: $API_KEY"