Read forwarding

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

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.

Request

GET/api/v1/mailbox/forwarding
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/forwarding' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

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 retrieved successfully",
  "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`.

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