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

Email aliases

Check an email alias

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

Whether @stacksync.email is free for a Genie's email channel or a workflow's email trigger step, checked in every region with that user's own rules. The Genies of one workspace may share an address; a step's own alias counts as free for that step. A read: any member of the workspace may check.

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.

alias*string

The email alias to check, the part before @stacksync.email.

Query Parameters

used_by*EmailAliasUser

genie for a Genie's email channel, workflow_email_trigger for a workflow's email trigger step

Value in"genie""workflow_email_trigger"
region?|

workflow_email_trigger only, required: the region of the workflow (besg or usnv)

Defaultnull
workflow_id?|

workflow_email_trigger only, required: the workflow of the email trigger step

Defaultnull
step_id?|

workflow_email_trigger only: the email trigger step; the alias it already has counts as free

Defaultnull

Response Body

OK

application/json
  1. response
alias*Alias

The alias checked, trimmed and in lower case as it is stored

email_address*Email Address

The address the alias gives, @stacksync.email

is_available*Is Available
reason?|

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

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