v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB

Mail: Autoreplies

Create autoreply

Create an automatic reply for the given mailbox. A mailbox can have only one autoreply. Omit starts_at to activate the autoreply immediately and omit ends_at to keep it active indefinitely.

post/api/mail/v1/mailboxes/{mailboxId}/autoreplies

Path parameters

mailboxIdstring required

Example:AC1a2b3c4d5e6f7g

Mailbox resource ID

Request body

subjectstring required

Subject of the automatic reply

bodystring required

Body of the automatic reply

display_namestring nullable

Sender display name used for the reply

starts_atstring date-time nullable

When the autoreply becomes active. Defaults to now.

ends_atstring date-time nullable

When the autoreply stops. Omit for an indefinite autoreply.

Example request

{
  "subject": "Out of office",
  "body": "I am on vacation until August 1st.",
  "display_name": "John Doe",
  "starts_at": "2026-08-01T00:00:00Z",
  "ends_at": "2026-09-01T00:00:00Z"
}

Response

Created response

idstring

Unique autoreply identifier

subjectstring

Subject of the automatic reply

bodystring

Body of the automatic reply

display_namestring nullable

Sender display name used for the reply

starts_atstring date-time

When the autoreply becomes active

ends_atstring date-time nullable

When the autoreply stops

created_atstring date-time

updated_atstring date-time

Example response

{
  "id": "AR1a2b3c4d5e6f7g",
  "mailbox": {
    "id": "AC1a2b3c4d5e6f7g",
    "address": "user@example.com"
  },
  "subject": "Out of office",
  "body": "I am on vacation until August 1st.",
  "display_name": "John Doe",
  "starts_at": "2026-08-01T00:00:00Z",
  "ends_at": "2026-09-01T00:00:00Z",
  "created_at": "2026-07-24T12:00:00Z",
  "updated_at": "2026-07-24T12:00:00Z"
}