Log inTry for free
Back to all APIs

Update working hours

Use this method to update working hours.

Please log in to see full path URL. Learn why.
put
/ccaas/1/working-hours/{id}
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
conversations:manage
path Parameters
id
required
string

Working hours Id.

Request Body schema:
application/json
collapse all -
timezone
required
string

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

message
required
string [ 0 .. 4000 ] characters

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

workWeek
object
Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

List of working hours work days. It must contain all days of the week with 3 parameters each: startTime, endTime and enabled.

startTime
integer <int32> [ 0 .. 1440 ]

Start time of the day in minutes after midnight.

endTime
integer <int32> [ 0 .. 1440 ]

End time of the day in minutes before midnight.

enabled
boolean

Daily working hours enable/disable toggle.

name
required
string [ 0 .. 255 ] characters

Working hours name.

enabled
boolean

Working hours enable/disable toggle.

isDefault
boolean

Default working hours.

closeConversations
boolean

Close conversation created outside of working hours toggle.

sendAwayMessageEveryOOWHPeriod
boolean
holidays
Array of objects

List of working hours holidays.

Array
name
required
string

Holiday name.

startDate
string <date-time>

Start date. Format: yyyy-MM-dd

endDate
string <date-time>

End date. Format: yyyy-MM-dd

enabled
boolean

Holiday enable/disable toggle.

Responses

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

Request samples

Content type
application/json
Copy
 Collapse all
{
  • "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
      }
    ]
}

Response samples

Content type
application/json

Successful response

Copy
 Collapse all
{
  • "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
      }
    ]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use