See Stacksync in action with a solution architect. Book a demo ↗
Genies

Genies

Check a Genie email alias

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

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

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

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

Query Parameters

alias*Alias

The part before @stacksync.email, without the @

Match^[^@]+$
Length1 <= length <= 64

Response Body

OK

application/json
  1. response
alias*Alias
is_available*Is Available
address*Address
reason?|

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

Defaultnull
Check a Genie email alias
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/genies/email-aliases/availability?alias=string'
{  "alias": "<alias>",  "is_available": false,  "address": "<address>",  "reason": "<reason>"}