Set forwarding

PUT/api/v1/mailbox/forwarding
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Forwards new mail to up to 5 addresses. keep_copy: false forwards without keeping a copy here. Send enabled: false to stop.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.
422 No address while turning it on, more than 5 addresses, or the mailbox's own address.

Request body

  • enabledboolean

    Forward new mail.

  • addressesarray<string>

    Where to, up to 5. Not this mailbox itself.

  • keep_copyboolean

    Keep a copy here as well.

Request

PUT/api/v1/mailbox/forwarding
curl -X PUT 'https://courier.mailyte.com/api/v1/mailbox/forwarding' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "addresses": [
      "ada.obi@gmail.com"
    ],
    "keep_copy": true
  }'

Response

Successful Response

  • dataobject
    • enabledboolean
    • addressesarray<string>
    • keep_copyboolean

      Keep a copy in this mailbox as well.

    • managedboolean

      True once set through this API.

200application/json
{
  "type": "success",
  "msg": "Forwarding saved",
  "data": {
    "enabled": true,
    "addresses": [
      "ada.obi@gmail.com"
    ],
    "keep_copy": true,
    "managed": true
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
422No address while turning it on, more than 5 addresses, or the mailbox's own address.

Every status, with what causes it and what to do, is on the error reference.