---
title: "Set the auto-reply"
method: PUT
path: "/mailboxes/{address}/auto-reply"
tags: ["Mailboxes"]
---

# Set the auto-reply

`PUT /mailboxes/{address}/auto-reply`

## Request

- Base URL: `https://faivelo.com/api/v1`
- URL: `https://faivelo.com/api/v1/mailboxes/{address}/auto-reply`
- Auth: HTTP bearer

Replaces the auto-reply. While it is on (and within `fromDate`/`toDate` when set), the mail server answers each sender once with `subject` and `textBody`/`htmlBody`, from the mailbox's own address; mailing-list and automated mail gets no reply. A field left out is cleared, so send the whole state; `{ "enabled": false }` switches it off. Refused with **409** when the mailbox runs its own mail filter script, since the server runs one script per mailbox. Requires scope `mail:write`.

## Path parameters

- `address` string, required

## Request body

- AutoReplyUpdate: The whole auto-reply; a field left out is cleared. An enabled reply needs `textBody` or `htmlBody`.
  - `enabled` boolean, required
  - `subject` string, nullable: Default: the server replies with "Re:" and the original subject
  - `textBody` string, nullable
  - `htmlBody` string, nullable
  - `fromDate` string, date-time, nullable: ISO 8601 with a timezone
  - `toDate` string, date-time, nullable: ISO 8601 with a timezone; must be after fromDate

## Response `200`

The auto-reply as it stands now

- object
  - `success` boolean
  - `data` AutoReply
    - `enabled` boolean
    - `subject` string, nullable
    - `textBody` string, nullable
    - `htmlBody` string, nullable
    - `fromDate` string, date-time, nullable: Replies start here; null means as soon as it is on
    - `toDate` string, date-time, nullable: Replies stop here; null means until switched off

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `404`: Resource not found
- `409`: The mailbox runs its own mail filter script
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/faivelo/apis/faivelo-api.md) · [All operations](https://skmtc.dev/faivelo/apis/faivelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faivelo/apis/faivelo-api/revisions/a7413ddea5d1?raw)