Get Failure Reason

POST

https://api.inboxkit.com/v1/api/mailboxes/failure-reason

Maintainer:Not configured

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200Success Response

application/json

Body

🟢200Mailbox Not Failed

🟠404Mailbox Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.inboxkit.com/v1/api/mailboxes/failure-reason' \
--header 'X-Workspace-Id: ws-123e4567-e89b-12d3-a456-426614174000' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uid": "mb-123e4567-e89b-12d3-a456-426614174000"
}'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Failure reason retrieved successfully",
    "data": {
        "uid": "mb-123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "status": "failed",
        "is_failed": true,
        "failure_message": "Domain is already in use in Google Workspace.",
        "failure_code": "DNS_CONNECTION_FAILED",
        "action_required": true,
        "internal_status": "order_failed",
        "original_reason": "Maximum retry count exceeded: Failed to create Google Workspace order",
        "inherited_from_admin": false
    }
}

Modified at 2026-01-24 11:29:39

Check mailbox availability

Get DNS records