Delete
/api/v1/email-inbox/{_id}
Deletes email inbox using ID.
Permissions required: manage-email-inbox
Changelog
| Version | Description |
|---|---|
| 3.11.0-rc.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
_id
stringRequired
Email inbox ID
Responses
200
OK
Success Example
{
"_id": "61717dd1066bc500096cb36d",
"success": true
}object
_id
string
success
boolean
400
Bad Request
Email not found
{
"success": false,
"error": "Resource not found"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string