Mailboxes

Update auto-reply settings

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

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)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

enabledboolean required

Whether auto-reply is active.

bodystring nullable

Reply message text. Required when enabled is true.

from_datestring date-time nullable

Start date in UTC ISO 8601.

to_datestring date-time nullable

End date in UTC ISO 8601.

Response

Updated mailbox.

object'mailbox' required
idstring required
domain_idstring required
addressstring required
display_namestring nullable required
suspended_atstring date-time nullable required

When the mailbox was suspended. Null if active.

suspension_reasonsstring[] required

Independent reasons currently keeping the mailbox suspended.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "address": "hello@example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.