WoyraDocs
Get an API key

Change a mailbox's quota, suspension or password

PATCH/v1/mailboxes/{id}

Mailboxes · Requires an API key

Suspension stops delivery and keeps every message. It is never deletion, and resuming loses nothing. Fields left out are unchanged.

A new password, or "" to remove it, ends every session the mailbox has: tokens minted before the change stop working at once.

Parameters

NameInDescription
idrequiredpath

Body

FieldTypeDescription
quota_bytesinteger
suspendedboolean
passwordstring12 to 256 characters, or "" to remove the password.

Example

curl -X PATCH https://api.woyra.io/v1/mailboxes/email_01J... \
  -H "Authorization: Bearer $WOYRA_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "quota_bytes": 1,
    "suspended": true,
    "password": "<password>"
  }'

Response

200 The mailbox as it now is.

FieldTypeDescription
objectrequired"mailbox"
idrequiredstring
addressrequiredstring
domain_idrequiredstring
quota_bytesrequiredintegernullNull is no quota.
suspendedrequiredbooleanDelivery stopped; mail retained.
suspended_attimestamp
has_passwordrequiredbooleanWhether someone can sign in to the mailbox directly.
past_duerequiredbooleanThe monthly charge could not be taken from the balance. Mail still arrives; signing in and sending resume once a top-up clears it.
created_atrequiredtimestamp

Errors

StatusCodes
400invalid_request, unsupported_version
404not_found, product_not_offered

Also in Mailboxes