v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01960201.2 KB

Aliases

Create alias

You may create your own mailbox alias using this action. It takes a JSON object containing a domain informations. Only one goto* option can be used, for ex. if you want learn as spam, then send just goto_spam = 1 in request body.

post/api/v1/add/alias

Request body

activeboolean

is alias active or not

addressstring

alias address, for catchall use "@domain.tld"

gotostring

destination address, comma separated

goto_hamboolean

learn as ham

goto_nullboolean

silently ignore

goto_spamboolean

learn as spam

sogo_visibleboolean

toggle visibility as selectable sender in SOGo

Example request

{
  "active": "1",
  "address": "alias@domain.tld",
  "goto": "destination@domain.tld"
}

Response

type'success' | 'danger' | 'error'

All 96 operations