MaillyDocs

Check whether a name on the platform domain looks free

GET
/onboarding/availability

Advisory check for the web page; it reserves nothing. Agents should call /start directly and handle 409 name_taken.

Query Parameters

name*string
Length1 <= length <= 64

Response Body

Whether the name can currently be reserved

application/json
  1. response
success*boolean
name*string
address*string
available*boolean
code?string
Value in"invalid""short""reserved""taken"
[key: string]?unknown
curl -X GET 'https://api.mailly.site/onboarding/availability?name=string'
{  "success": true,  "name": "string",  "address": "string",  "available": true,  "code": "invalid",  "property1": null,  "property2": null}