Update an alias

PATCH

/api/v1/aliases/{address}

const url = 'https://app.shroud.email/api/v1/aliases/deadbeef%40fog.shroud.email';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"enabled":false,"notes":"Receipts and order updates","title":"Acme shopping"}'
};

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

curl --request PATCH \
  --url https://app.shroud.email/api/v1/aliases/deadbeef%40fog.shroud.email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": false, "notes": "Receipts and order updates", "title": "Acme shopping" }'

Updates an alias’s settings. OAuth scope: aliases:edit.

Authorizations

bearerAuth

Parameters

Path Parameters

address

required

string

Exact alias address. URL-encode it, e.g. deadbeef%40fog.shroud.email.

Example

deadbeef@fog.shroud.email

Request Body

Fields to update

application/json

UpdateAlias

Omitted fields remain unchanged.

object

enabled

False stops all forwarding, including password-reset emails.

boolean

notes

Set to null to clear the notes.

string

nullable

title

Set to null to clear the label.

string

nullable

Example

{
  "enabled": false,
  "notes": "Receipts and order updates",
  "title": "Acme shopping"
}

Responses

200

Updated 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": "deadbeef@fog.shroud.email",
  "blocked": 33,
  "blocked_addresses": [
    "spammer@example.com"
  ],
  "enabled": true,
  "forwarded": 26,
  "notes": "Used for webshop newsletters etc.",
  "title": "Newsletters"
}

401

Invalid token

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}

403

Insufficient scope or unconfirmed account

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}

404

Alias not found

application/json

Error

object

error

required

string

Example

{
  "error": "Alias not found"
}

422

Invalid values

application/json

Error

object

error

required

string

Example

{
  "error": "is invalid"
}