Read the vacation reply

GET/api/v1/mailbox/vacation
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/vacation
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/vacation' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • enabledboolean
    • subjectstring or null
    • messagestring or null
    • start_datestring or null

      YYYY-MM-DD.

    • end_datestring or null

      YYYY-MM-DD.

    • managedboolean
200application/json
{
  "type": "success",
  "msg": "Vacation retrieved successfully",
  "data": {
    "enabled": false,
    "subject": null,
    "message": null,
    "start_date": null,
    "end_date": null,
    "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.