mailboxes

Check name availability

No auth needed. Signed-in callers get answers for their plan (short names); anonymous and pending callers get free-plan answers. Rate limit: 60/minute per IP.

get/v1/names/{name}

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/names/{name}
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in cookie bm_session

Path parameters

namestring required

Local part to check (normalized to lower case).

Response

Availability. message and hint are set when unavailable.

namestring required
availableboolean required
reason'' | 'invalid' | 'reserved' | 'short_name_requires_paid_plan' | 'taken' | 'held' | 'retired' required

Empty when available.

shortboolean required

4 characters or fewer.

messagestring
hintstring

Changes

No recorded changes to this operation across all 1 revision of this API.