WoyraDocs
Get an API key

Create or repoint an alias

POST/v1/aliases

Mailboxes · Requires an API key

An alias delivers to one or more mailboxes on the same account. Posting an address that is already an alias repoints it (200); a new address creates one (201). Destinations must be mailboxes on this account: aliases never forward outside it, so none can become an open relay.

Body

FieldTypeDescription
domain_idrequiredstring
local_partrequiredstring
destinationsrequiredarray of string

Example

curl -X POST https://api.woyra.io/v1/aliases \
  -H "Authorization: Bearer $WOYRA_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "domain_id": "<domain_id>",
    "local_part": "<local_part>",
    "destinations": [
      "sms",
      "email"
    ]
  }'

Response

200 The alias, repointed.

FieldTypeDescription
objectrequired"alias"
idrequiredstring
addressrequiredstring
domain_idrequiredstring
destinationsrequiredarray of string
created_atrequiredtimestamp
updated_atrequiredtimestamp

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key
403insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required

Also in Mailboxes