Update Exception on Door Exception Calendar

Update an Exception having the specified exception_id on a Door Exception Calendar having the specified calendar_id.

To use this API, you need an API Key having permission "Door Access Management" for all sites including doors listed in doors for the Door Exception Calendar. Manage via API must also be enabled for all doors listed in doors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
boolean
Defaults to false

Bool value specifying if Exception is an All Day Default. If TRUE, then:

  • door_status must be set to access_controlled
  • start_time and end_time will automatically be set to 00:00:00 and 23:59:59, respectively. Different values should not be provided.
  • first_person_in and double_badge must be FALSE
string
required

Date of the Door Exception formatted as YYYY-MM-DD (according to ISO 8601).

string
enum

An enumeration.

Allowed:
boolean
Defaults to false

Bool value specifying if the Double Badge setting should be enabled for relevant doors. If TRUE, door_status must be set to access_controlled.

By default, all users with access to relevant doors will be allowed to double badge.

double_badge_group_ids
array of strings

List of IDs for Access Groups that users must be a member of to be allowed to double badge on relevant doors.

double_badge must also be set to TRUE if value is provided.

Double Badge Group Ids
string
required

End time of the Door Exception formatted as hh:mm (according to ISO 8601).

boolean
Defaults to false

Bool value specifying if the First Person In setting should be enabled for relevant doors. If TRUE, door_status must be set to card_and_code, access_controlled, or unlocked.

first_person_in_group_ids
array of strings

List of IDs for Access Groups including supervisors used for First Person In mode.

first_person_in must also be set to TRUE if this value is provided.

First Person In Group Ids
recurrence_rule
object

A recurrence rule object specifying when the exception should repeat.

string
required

Start time of the Door Exception formatted as hh:mm (according to ISO 8601).

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json