Method: GET

https://api-prod.enotifiers.com/api/V1/service/email/details?emailName=email_test

Curl code

Success response details

Parameter	Description	Example
status String	Indicates the success status of the API operation	success
code String	Provides the status code indicating the success of the request.	200
message String	A descriptive message confirming the success of the operation.	Successfully fetched E-mail details.
data.mailName String	The name of the email service.	email_test
data.sourceEmail String	The source email address.	name@mindorigin.in
data.templateCategory String	The category of the email template.	testing_1
data.templateName String	The name of the email template.	test_without
data.subject String	The subject of the email.	email_test
data.description String	A description of the email service.	email_test
data.mailType String	The type of email	transactional
data.createdAt String	The timestamp indicating when the email service was created.	2024-03-14 06:01:34
data.groupName String	The name of the group associated with the email service.	testinGrp
data.modifiedBy.username String	The username of the user who made the modification.	Ram
data.modifiedBy.modifiedAt String	The timestamp indicating when the modification occurred.	2024-03-14 06:01:34
data.modifiedBy.modifiedFields String	A description of the modification made by the user.	Created the Category
data.addedBy String	The username of the user who added the email service.	Ram
data.email_info.id String	The unique identifier for the email.	65f292e7e1751af1ebdfea01
data.email_info.started_at String	The timestamp indicating when the email sending started.	2024-03-14T06:02:15.560000
data.email_info.email_status String	The status of the email.	completed
data.email_info.success_email_count integer	The count of successfully sent emails.	1
data.email_info.failure_email_count integer	The count of failed emails.	0
data.email_info.failure_email_list array	List of failed email addresses.	[ "example1@example.com", "example2@example.com", "example3@example.com" ]
data.email_info.update_time String	The timestamp indicating when the email information was last updated.	2024-03-14T06:02:15.761000
data.email_info.sentUser String	The user who initiated the email sending.	Ram

{
    "status": "success",
    "code": "200",
    "message": "Successfully fetched E-mail details.",
    "data": {
        "mailName": "email_test",
        "sourceEmail": "ranjini.nv@mindorigin.in",
        "templateCategory": "testing_1",
        "templateName": "test_without",
        "subject": "email_test",
        "description": "email_test",
        "mailType": "transactional",
        "createdAt": "2024-03-14 06:01:34",
        "groupName": "testinGrp",
        "modifiedBy": [
            {
                "username": "ranjini",
                "modifiedAt": "2024-03-14 06:01:34",
                "modifiedFields": "Created the Category"
            }
        ],
        "addedBy": "ranjini",
        "email_info": [
            {
                "id": "65f292e7e1751af1ebdfea01",
                "started_at": "2024-03-14T06:02:15.560000",
                "email_status": "completed",
                "success_email_count": 1,
                "failure_email_count": 0,
                "failure_email_list": [],
                "update_time": "2024-03-14T06:02:15.761000",
                "sentUser": "ranjini"
            }
        ]
    }
}

Failure response details

Parameter	Description	Example
status String	Indicates the overall status of the API request.	failed
code String	Provides the HTTP status code corresponding to the failure.	400
message String	Provides the reason for the error	E-mail not found
data.error String	Specific error message providing more context about the issue.	No document found for the given email name

{
    "status": "failed",
    "code": "400",
    "message": "E-mail not found.",
    "data": {
        "error": "No document found for the given email name."
    }
}