Skip to main content

Transaction Email / Delete email (transactional)

Delete email (transactional)

Method: DELETE

https://api-prod.enotifiers.com/api/V1/service/email/delete

Request details

API Parameters
Parameter Description Example
mailName
string
The name of the email. email_test

Curl code

Tabbed Interface
curl --location --request DELETE 
            'https://api-prod.enotifiers.com/api/V1/service/email/delete' \
            --header 'accept: application/json' \
            --header 'Content-Type: application/json' \
            --header 'Authorization: Basic {{Authorization}}' \
            --data '{
              "mailName": "email_test1"
            }'

Success response details

API Parameters
Parameter Description Example
status
String
Provides the status of the API success
code
String
Povides the HTTP code of the API 200
message
String
A message indicating the success
of the operation.
mail deleted successfully
data.mailName
String
Specifies the name of the deleted email
service.
email_test
data.status
String
Indicates the status of the deleted email
service
deleted
{
    "status": "success",
    "code": "200",
    "message": "Email deleted successfully.",
    "data": {
        "mailName": "email_test2",
        "status": "Deleted."
    }
}

Failure response details

API Parameters
Parameter Description Example
status
String
Provides the status of the API failed
code
String
Povides the HTTP code of the API 400
message
String
Provides the reason for the error email does not exist
data.error
String
Specifies the error message
detailing why the operation
failed
email does not exist
{
    "status": "failed",
    "code": "400",
    "message": "Email does not exist.",
    "data": {
        "error": "Email does not exist."
    }
}

Document

Policy

Terms of Use

policy

© 2024 E-Notifiers. All rights reserved.