public

Check whether a name on the platform domain looks free

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

get/onboarding/availability

Request

  • Base URL: https://api.mailly.site (the document declares no server; this is the origin it was published from)
  • URL: https://api.mailly.site/onboarding/availability
  • Auth: none required

Query parameters

namestring required

Response

Whether the name can currently be reserved

successboolean required
namestring required
addressstring required
availableboolean required
code'invalid' | 'short' | 'reserved' | 'taken'

Changes

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