# Check if a mailbox can be provisioned (https://developer.godaddy.com/en/docs/references/rest/email/check-mailbox-eligibility)

---
title: Check if a mailbox can be provisioned
description: >-
  Determines whether a mailbox can be provisioned for the given email address
  and which entitlements are available to use.
full: true
---

Full description

\| Determines whether a mailbox can be provisioned for the given email address and which entitlements are available to use.

## GET /check-mailbox-eligibility

Check if a mailbox can be provisioned

Determines whether a mailbox can be provisioned for the given
email address and which entitlements are available to use.


### Query parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `email` | string <email> | yes | Full email address to check (user@domain). |

### Header parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `X-Request-Id` | string <uuid> | no | Optional client-generated request correlation identifier. Propagated across services and echoed in the X-Request-Id response header. |

### Responses

**200** — Eligibility result for the requested email address.

Content-Type: `application/json`

```json
{
  "isEligible": true,
  "eligibleAccounts": [
    {
      "accountId": "00000000-0000-0000-0000-000000000002",
      "mailboxType": "TITAN",
      "accountName": "Professional Email Pro Plus",
      "default": false,
      "requirements": [
        {
          "type": "FREETRIAL_AUTORENEW",
          "title": "Free Trial Auto Renew",
          "reference": "https://www.godaddy.com/agreements/showdoc?pageid=FREETRIAL_AUTORENEW"
        }
      ]
    }
  ]
}
```

Schema:

- schema reference: `#/components/schemas/EligibilityResult`

**400** — Malformed request syntax, missing required field, or invalid field value.

Content-Type: `application/json`

```json
{
  "name": "INVALID_INPUT",
  "correlationId": "req-abc-123",
  "message": "The provided request is invalid.",
  "details": [
    {
      "field": "/username",
      "issue": "PATTERN_VIOLATION",
      "location": "body",
      "description": "Username must contain only letters, digits, dots, underscores, hyphens, and plus signs.\n"
    }
  ]
}
```

Schema:

- schema reference: `#/components/schemas/Error`

**401** — Authentication credentials are missing or invalid.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**403** — Authenticated identity is not authorized to perform this operation.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**422** — The address is not eligible for mailbox provisioning. Check details[] in the response for the specific reason.

Content-Type: `application/json`

```json
{
  "name": "ELIGIBILITY_FAILURE",
  "correlationId": "7f3a9c21-5d84-4e67-b912-3a8f6c2d104e",
  "message": "Found 1 reason why this email address cannot be provisioned.",
  "details": [
    {
      "issue": "EMAIL_PLAN_NOT_AVAILABLE",
      "description": "You need to purchase an email plan to create an email address."
    }
  ]
}
```

Schema:

- schema reference: `#/components/schemas/EligibilityError`

**429** — Too many requests — rate limit exceeded.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**Security:** requires `bearerAuth`.