Create an alias

POST

/api/v1/aliases

const url = 'https://app.shroud.email/api/v1/aliases';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"domain":"example.com","local_part":"myemail","notes":"Used for shopping receipts","title":"Acme"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.shroud.email/api/v1/aliases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "domain": "example.com", "local_part": "myemail", "notes": "Used for shopping receipts", "title": "Acme" }'

Creates an enabled alias with a random or custom address. Random addresses use the default shared domain (@fog.shroud.email on hosted Shroud.email). OAuth scope: aliases:create.

Authorizations

bearerAuth

Request Body

Optional alias settings

application/json

CreateAlias

Omit both local_part and domain for a random alias; otherwise supply both strings.

object

domain

A custom domain owned by your account.

string

local_part

string

notes

string

nullable

title

string

nullable

Example

{
  "domain": "example.com",
  "local_part": "myemail",
  "notes": "Used for shopping receipts",
  "title": "Acme"
}

Responses

200

Created alias

application/json

EmailAlias

object

address

required

string format: email

blocked

required

integer

blocked_addresses

required

Array<string>

enabled

required

boolean

forwarded

required

integer

notes

required

string

nullable

title

required

string

nullable

Example

{
  "address": "myemail@example.com",
  "blocked": 0,
  "blocked_addresses": [],
  "enabled": true,
  "forwarded": 0,
  "notes": "Used for shopping receipts",
  "title": "Acme"
}

401

Invalid token

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}

403

Insufficient scope, unconfirmed/inactive account, or free plan alias limit reached

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}

422

Invalid metadata, address, or domain

application/json

Error

object

error

required

string

Example

{
  "error": "Domain not found"
}