Set the vacation reply
PUT
/api/v1/mailbox/vacationAn 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
enabledbooleanSend the automatic reply.
subjectstring or nullThe reply's subject.
messagestring or nullThe reply's text. Needed to turn it on.
start_datestring or nullFirst day (YYYY-MM-DD), optional.
end_datestring or nullLast day (YYYY-MM-DD), optional.
Request
PUT
/api/v1/mailbox/vacationcurl -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"
}'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/vacation', {
method: 'PUT',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"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"
}),
});
const { data } = await response.json();import requests
response = requests.put(
"https://courier.mailyte.com/api/v1/mailbox/vacation",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
json={
"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"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->put('https://courier.mailyte.com/api/v1/mailbox/vacation', [
'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',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/vacation")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
request["Content-Type"] = "application/json"
request.body = {
"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"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataobjectenabledbooleansubjectstring or nullmessagestring or nullstart_datestring or nullYYYY-MM-DD.
end_datestring or nullYYYY-MM-DD.
managedboolean
200
application/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
| 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`. |
Every status, with what causes it and what to do, is on the error reference.