Skip to main content
POST
/
v1
/
public
/
accounts
/
{account_id}
/
mailboxes
/
{mailbox}
/
aliases
Create Mailbox Alias
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "is_catch_all": false
}
'
{
  "alias": "<string>",
  "is_catch_all": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

account_id
string<uuid>
required
mailbox
string
required

Body

application/json

Request body for creating a mailbox alias.

alias
string
required
is_catch_all
boolean
default:false

Response

alias
string
required

Mailbox alias email address

is_catch_all
boolean
default:false

Whether this alias catches all unmatched local parts