Set the vacation reply

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

An automatic reply to people who write while you are away, optionally between two dates. Send enabled: false to stop it.

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 Write the message to send, or turn the responder off.

Request body

  • enabledboolean

    Send the automatic reply.

  • subjectstring or null

    The reply's subject.

  • messagestring or null

    The reply's text. Needed to turn it on.

  • start_datestring or null

    First day (YYYY-MM-DD), optional.

  • end_datestring or null

    Last day (YYYY-MM-DD), optional.

Request

PUT/api/v1/mailbox/vacation
curl -X PUT 'https://courier.mailyte.com/api/v1/mailbox/vacation' \
  -H 'Authorization: Bearer MAILBOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "subject": "Out of office",
    "message": "I'm away until 20 October and will reply then.",
    "start_date": "2026-10-13",
    "end_date": "2026-10-20"
  }'

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 responder saved",
  "data": {
    "enabled": true,
    "subject": "Out of office",
    "message": "I'm away until 20 October and will reply then.",
    "start_date": "2026-10-13",
    "end_date": "2026-10-20",
    "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`.
422`Write the message to send, or turn the responder off`.

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