Create Agent Working Hours

POST 
/conversation-ai/agents/:agentId/working-hours

Creates the working-hours configuration for an AI agent. Returns 409 when one already exists — use the update endpoint to replace it.

Request

Version stringrequired

API Version

Available options2021-04-15

agentId stringrequired

Conversations AI agent id

application/json

application/json

Body

Bodyrequired

enabledbooleanrequired

Master toggle for working hours.

channelsstring[]required
Channels the gate applies to. Must be non-empty when enabled.
Available optionsSMSEmailWhatsAppIGFBWebChatLive_ChatTIKTOK
timezoneModestringrequired
Available optionscontactbusiness
scheduleobjectrequired
continueConversationsobjectrequired
offHoursAutoReplyobjectrequired
followUpobjectrequired

Example (auto)

{
  "enabled": false,
  "channels": [
    "SMS",
    "WhatsApp"
  ],
  "timezoneMode": "contact",
  "schedule": {
    "mon": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "tue": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "wed": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "thu": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "fri": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "sat": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    },
    "sun": {
      "enabled": true,
      "slots": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 0
        }
      ]
    }
  },
  "continueConversations": {
    "enabled": true,
    "inactivityTimeout": {
      "value": 15,
      "unit": "minutes"
    }
  },
  "offHoursAutoReply": {
    "enabled": false,
    "message": "Thanks for reaching out! We're currently outside of business hours.",
    "sendNotification": false,
    "notificationConfig": {
      "emailNotification": {
        "enabled": false,
        "notifyAdmins": false,
        "notifyAllUsers": false,
        "notifyAssignedUser": false,
        "notifySpecificUsers": false,
        "specificUserIds": [],
        "notifyCustomEmail": false,
        "customEmail": ""
      },
      "contactTags": []
    }
  },
  "followUp": {
    "enabled": false,
    "message": "Hi {{contact.name}}, we're here now and happy to help."
  }
}

application/json

Successful response

application/json

Schema

Schema

dataobjectrequired
successbooleanrequired

Example (auto)

{
  "data": {
    "enabled": false,
    "channels": [
      "SMS",
      "WhatsApp"
    ],
    "timezoneMode": "contact",
    "schedule": {
      "mon": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "tue": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "wed": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "thu": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "fri": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "sat": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      },
      "sun": {
        "enabled": true,
        "slots": [
          {
            "startHour": 9,
            "startMinute": 0,
            "endHour": 17,
            "endMinute": 0
          }
        ]
      }
    },
    "continueConversations": {
      "enabled": true,
      "inactivityTimeout": {
        "value": 15,
        "unit": "minutes"
      }
    },
    "offHoursAutoReply": {
      "enabled": false,
      "message": "Thanks for reaching out! We're currently outside of business hours.",
      "sendNotification": false,
      "notificationConfig": {
        "emailNotification": {
          "enabled": false,
          "notifyAdmins": false,
          "notifyAllUsers": false,
          "notifyAssignedUser": false,
          "notifySpecificUsers": false,
          "specificUserIds": [],
          "notifyCustomEmail": false,
          "customEmail": ""
        },
        "contactTags": []
      }
    },
    "followUp": {
      "enabled": false,
      "message": "Hi {{contact.name}}, we're here now and happy to help."
    },
    "employeeId": "wK36brxPYCOikC85FkbA",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "success": true
}