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

Workflows

Check a workflow email alias

GET
/v1/workspaces/{workspace_id}/workflows/{workflow_id}/email-aliases/{alias}

Whether @stacksync.email is free for an email trigger step of this workflow (aliases are unique across every workspace); the step's own alias counts as free.

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.

workflow_id*string

The workflow.

Formatuuid
alias*string

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

Query Parameters

region*Regions

Data region of the resources: besg (Europe) or usnv (United States), as GET /v1/regions lists them.

Value in"besg""usnv"
step_id?|

The email trigger step that would use it: its own alias does not count as taken

Defaultnull

Response Body

OK

application/json
  1. response
alias*Alias
email_address*Email Address
is_available*Is Available
Check a workflow email alias
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/email-aliases/string?region=besg'
{  "alias": "<alias>",  "email_address": "<email_address>",  "is_available": false}