Add a schedule access to the given user

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Post
/api/v1/users/{userId}/schedule-access
Security
HTTP
Type bearer
Path parameters
userId
stringRequired

The ID of the user

Body parameters

The details for the schedule access

Expand All
object
end
string
Example2023-07-20
notifyAt
string
Example2023-07-18T08:30:00-0700
recurrence
object
byDay
Array of string
string
ExampleSU
byMonth
Array of integer
integer
Example5
byMonthDay
Array of integer
integer
Example10
bySetPos
Array of integer
integer
Example1
endTime
string
Example17:00
frequency
string
ExampleMONTHLY
startTime
string
Example09:00
removeUserAfterLastSchedule
boolean
Examplefalse
start
string
Example2023-07-18
timezone
string
ExampleAmerica/Los_Angeles
Responses
200

OK

Expand All
object
authorization
boolean
data
object (ScheduleAccess)
enabled
boolean
end
string
notifyAt
string
recurrence
object
byDay
Array of string
string
byMonth
Array of integer
integer
byMonthDay
Array of integer
integer
bySetPos
Array of integer
integer
endTime
string
frequency
string
interval
integer
startTime
string
until
string
removeUserAfterLastSchedule
boolean
start
string
timezone
string
error_code
integer
error_message
string
error_status
boolean
Examplefalse
400

Bad Request

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
401

Unauthorized

object
error_code
integer
error_message
string
error_status
boolean
404

Not Found

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
422

Unprocessable Entity

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
500

Internal Server Error

object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean