DELETE · Email
List, create, update or delete vacation messages
List, create, update or delete vacation messages
DELETE
/api/v1/email/vacation
Description
action=list returns each mailbox address with its startDate/endDate. create/ update need address, text, start_date and end_date; delete needs address. The three writes require the write:email scope.
Query parameters
| Name | Type | Description |
|---|---|---|
input
required
|
string |
A domain, email address, website URL, or Inleed service id — for example example.se, [email protected] or 42976. Resolved to the owning account automatically, and the resolved target is echoed back in the response. Up to 255 characters.
|
action
required
|
enum |
list all vacation messages, create a new one, update an existing one, or delete one. Anything but list requires the write:email scope. One of list, create, update, delete.
|
address
|
string |
The mailbox the vacation reply is on, e.g. [email protected].
|
text
|
string | The out-of-office message body. Required for create and update. |
start_date
|
string |
The day the auto-reply starts, YYYY-MM-DD. Required for create and update.
|
end_date
|
string |
The day the auto-reply ends, YYYY-MM-DD (on or after start_date). Required for create and update.
|
start_time
|
enum |
One of morning, afternoon, evening.
|
end_time
|
enum |
One of morning, afternoon, evening.
|
cc
|
string | Optional: an address to copy each auto-reply to. |
Responses
The specification does not describe this response body; the note in the rail says what to expect.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.
400
401
No token was presented, or the token is revoked, expired or unknown.
403
The token lacks a required scope, or this account does not own the resource.
404
No such resource for this account.
422
Validation error
429
The rate limit for this token is exhausted. See `Retry-After`.
500
Something went wrong on our side. The failure is logged against `requestId`.