STstacksync
Genies

Check a Genie email alias

Whether an email alias is free for a Genie's email channel (<alias>@stacksync.email); checked in every region.

get/v1/workspaces/{workspace_id}/genies/email-aliases/availability

Request

  • Base URL
    https://api.stacksync.com
  • URL
    https://api.stacksync.com/v1/workspaces/{workspace_id}/genies/email-aliases/availability
  • Auth
    HTTP bearer

Path parameters

workspace_idinteger required

The workspace. List the ones your key can reach with GET /v1/workspaces.

Query parameters

aliasstring required

The part before @stacksync.email, without the @

Response

OK

aliasstring required
is_availableboolean required
addressstring required
reasonstring nullable

Why the alias cannot be used, or with whom it is shared; null when it is free

Changes

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