Comment on page
Delete email inbox by id
Deletes email inbox using id.
requires the user to have
manage-email-inbox
permission.URL | Requires Auth | HTTP Method |
---|---|---|
/api/v1/email-inbox/:_id | yes | DELETE |
Argument | Example | Required | Description |
---|---|---|---|
_id | 60197e8ff82d6c83b96c53ff | Required | Email inbox id |
curl -L -X DELETE 'http://localhost:3000/api/v1/email-inbox/61717dd1066bc500096cb36d' \
-H 'X-User-Id: d26x6zSkaPSe5gCyy' \
-H 'X-Auth-Token: Zu-Z6eKzIIz7MCCRGeHi29bYkXZCJ4SxFC0JAasqm92'
{
"_id": "61717dd1066bc500096cb36d",
"success": true
}
The following error can occur upon the endpoint.
- Authorization: Requires an authentication token for the request to be made.
- Permission: Requires the user to have
manage-email-inbox
permission for the request to be made. - Email Not Found: Triggered when the email entry with this
_id
is not found.
Authorization
Permission
Email Not Found
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "error-not-allowed"
}
{
"success": false,
"error": "Resource not found"
}
Version | Description |
---|---|
3.11.0-rc.0 | Added |
Last modified 1yr ago