Endpoints

Update an email alias note.

This endpoint allows you to update the note for a specific email alias.

patch/api/v1/aliases

Request

Base URL: https://hidemail.app
URL: https://hidemail.app/api/v1/aliases
Auth: HTTP bearer

Request body

notestring required

The new note for the alias. Max 255 characters. Must not be greater than 255 characters.

emailstring required

The email alias to update. Must be a valid email address.

Example request

{
  "note": "My shopping account",
  "email": "alias@hidemail.app"
}

Response

Example response

{
  "data": {
    "email": "alias@hidemail.app",
    "note": "My shopping account",
    "is_active": true,
    "created_at": "2024-01-28T15:03:09.000000Z",
    "updated_at": "2024-01-28T15:03:09.000000Z",
    "total_forwarded": 0,
    "total_blocked": 0
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.