Genies
Genies
Check a Genie email alias
GET
Whether an email alias is free for a Genie's email channel (@stacksync.email); checked in every region.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
alias*AliasThe part before @stacksync.email, without the @
Match
^[^@]+$Length
1 <= length <= 64OK
application/json- response
alias*Aliasis_available*Is Availableaddress*Addressreason?|Why the alias cannot be used, or with whom it is shared; null when it is free
Default
nullcurl -X GET 'https://api.stacksync.com/v1/workspaces/0/genies/email-aliases/availability?alias=string'{ "alias": "<alias>", "is_available": false, "address": "<address>", "reason": "<reason>"}