---
title: "Update auto-reply settings"
method: PATCH
path: "/mailboxes/{id}/auto-reply"
tags: ["Mailboxes"]
---

# Update auto-reply settings

`PATCH /mailboxes/{id}/auto-reply`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/mailboxes/{id}/auto-reply`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

Configure auto-reply (vacation/out-of-office) for a mailbox. When enabled, incoming emails receive an automatic response.

## Headers

- `X-Shipmail-Organization` string

## Request body

- UpdateAutoReplyRequest
  - `enabled` boolean, required: Whether auto-reply is active.
  - `body` string, nullable: Reply message text. Required when enabled is true.
  - `from_date` string, date-time, nullable: Start date in UTC ISO 8601.
  - `to_date` string, date-time, nullable: End date in UTC ISO 8601.

## Response `200`

Updated mailbox.

- Mailbox
  - `object` 'mailbox', required
  - `id` string, required
  - `domain_id` string, required
  - `address` string, required
  - `display_name` string, nullable, required
  - `suspended_at` string, date-time, nullable, required: When the mailbox was suspended. Null if active.
  - `suspension_reasons` string[], required: Independent reasons currently keeping the mailbox suspended.
  - `auto_reply` object, required
    - `enabled` boolean, required
    - `subject` string, nullable, required
    - `body` string, nullable, required
    - `from_date` string, date-time, nullable, required
    - `to_date` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `401`: Authentication failed.
- `403`: Insufficient permissions.
- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

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