Create working hours holiday

Use this method to create a holiday on working hours. An auto-reply message will be sent to the customer when working hours are set and enabled and a new conversation is created outside of working hours, or a holiday is set for the enabled working hours and a new conversation is created during the holiday. This method will return a full working hours object with a created holiday in it.

post/ccaas/1/working-hours/{workingHoursId}/holiday

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Path parameters

workingHoursIdstring required

Working hours id.

Request body

idstring

Holiday ID.

namestring required

Holiday name.

startDatestring date-time

Start date. Format: yyyy-MM-dd

endDatestring date-time

End date. Format: yyyy-MM-dd

enabledboolean

Holiday enable/disable toggle.

Example request

{
  "id": "aae9b06f-a323-4c9c-b807-7a9e4e015405",
  "workingHoursId": "07ad4193-4354-488c-b45f-293dfa4c90fb",
  "name": "New Year's Day",
  "startDate": "2021-01-01",
  "endDate": "2021-01-01",
  "enabled": true
}

Response

idstring

Working hours Id.

timezonestring required

Timezone in which working hours apply. TZ database name from IANA time zone database

messagestring required

Message to be sent as an auto-reply message to the customer.

namestring required

Working hours name.

enabledboolean

Working hours enable/disable toggle.

isDefaultboolean

Default working hours.

closeConversationsboolean

Close conversation created outside of working hours toggle.

sendAwayMessageEveryOOWHPeriodboolean

Example response

{
  "id": "07ad4193-4354-488c-b45f-293dfa4c90fb",
  "timezone": "Etc/UTC",
  "message": "We're out of office, come back another time, thank you!",
  "workWeek": {
    "MONDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "TUESDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "WEDNESDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "THURSDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "FRIDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "SATURDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    },
    "SUNDAY": {
      "startTime": 0,
      "endTime": 1440,
      "enabled": true
    }
  },
  "name": "My Working Hours",
  "enabled": true,
  "isDefault": true,
  "closeConversations": false,
  "holidays": [
    {
      "id": "aae9b06f-a323-4c9c-b807-7a9e4e015405",
      "workingHoursId": "07ad4193-4354-488c-b45f-293dfa4c90fb",
      "name": "New Year's Day",
      "startDate": "2021-01-01",
      "endDate": "2021-01-01",
      "enabled": true
    },
    {
      "id": "6bfb9b10-caec-4f53-85a9-b87da6afa88f",
      "workingHoursId": "07ad4193-4354-488c-b45f-293dfa4c90fb",
      "name": "My Holiday",
      "startDate": "2021-06-09",
      "endDate": "2021-06-09",
      "enabled": false
    }
  ]
}

Changes

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