Skip to content
HALOWERK

Textwerk

out of office

Computes the return day as the first day after the absence that is neither a Saturday, Sunday nor a public holiday of the chosen country and region (date-holidays 3.38, data CC BY-SA 3.0; Germany by state, Austria, Switzerland by canton) and writes a fixed, formal message per language: absence period with dates formatted by the Unicode CLDR rules of the runtime (Intl.DateTimeFormat), optional reason (vacation, business trip, training), return day with weekday, deputy with contact and whether.

POST https://text.halowerk.com/v1/out-of-office

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
namestringYesYour name for the signature.
fromstringYesFirst day of absence.
tostringYesLast day of absence.
languagesarrayYes
reasonstringNoOptional reason shown in the text (other = no reason).
deputyobjectNo
forwardingbooleanNoMessages are forwarded during the absence.
countrystringNo
regionstringNoGerman state or Swiss canton code (e.g. NW, BY, ZH) for regional holidays.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "from",
    "to",
    "languages"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 120,
      "description": "Your name for the signature."
    },
    "from": {
      "type": "string",
      "format": "date",
      "description": "First day of absence."
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "Last day of absence."
    },
    "languages": {
      "type": "array",
      "minItems": 1,
      "maxItems": 6,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "de",
          "en",
          "fr",
          "es",
          "it",
          "nl"
        ]
      }
    },
    "reason": {
      "type": "string",
      "enum": [
        "vacation",
        "business_trip",
        "training",
        "other"
      ],
      "default": "other",
      "description": "Optional reason shown in the text (other = no reason)."
    },
    "deputy": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 120
        },
        "contact": {
          "type": "string",
          "maxLength": 120,
          "description": "E-mail or phone of the deputy."
        }
      }
    },
    "forwarding": {
      "type": "boolean",
      "default": false,
      "description": "Messages are forwarded during the absence."
    },
    "country": {
      "type": "string",
      "enum": [
        "DE",
        "AT",
        "CH"
      ],
      "default": "DE"
    },
    "region": {
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "description": "German state or Swiss canton code (e.g. NW, BY, ZH) for regional holidays."
    }
  }
}

Open original schema

Published input example

{
  "name": "Dokumentationsteam",
  "from": "2026-12-21",
  "to": "2027-01-01",
  "languages": [
    "de",
    "en"
  ],
  "reason": "vacation",
  "deputy": {
    "name": "API-Betrieb",
    "contact": "api@halowerk.com"
  },
  "country": "DE",
  "region": "NW"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →