Update Schedule
PATCH/v1/schedules/{uid}The Update Schedule API allows users to modify an existing manually created schedule. By providing the schedule id and the fields to be updated, users can adjust details such as time, date, or other schedule-specific information. This API is used to update schedules that are visible on the Jicoo calendar page, ensuring that your calendar remains accurate and up-to-date.
Request
Path Params
uid
string
required
Body Params application/json
name
string
optional
<= 64 characters
description
optional
Any of
<= 10000 characters
routine
optional
Any of
duration
integer
required
> 0
endedAt
required
schedules
array [object {8}]
required
isRemind
boolean
optional
projectId
optional
Any of
> 0
phoneNumber
optional
Any of
<= 32 characters
access
optional
Any of
<= 2000 characters
address
optional
Any of
<= 255 characters
customLocation
optional
Any of
<= 2000 characters
attendees
array [object {4}]
optional
userId
string
optional
email
string <email>
optional
role
enum<string>
required
Allowed values:
admineditorviewer
userType
enum<string>
required
Allowed values:
hostguest
isAllDay
boolean
optional
timeZone
string
optional
startedAt
optional
Any of
endedAt
optional
Any of
priority
optional
Any of
Allowed values:
lowmiddlehigh
displayType
enum<string>
optional
Allowed values:
privateteamPublicpublic
location
optional
Any of
Allowed values:
inPersonphonezoomgoogleMeetaskInviteeteamscustom
transparency
enum<string>
optional
Allowed values:
opaquetransparent
behavior
enum<string>
optional
Allowed values:
eventwork
visibilityType
enum<string>
optional
Allowed values:
defaultbusy
updateMessage
string
optional
<= 2000 characters
isSendUpdates
boolean
optional
Example
{
"name": "a",
"description": null,
"startedAt": "2024-02-18T10:00:00.000Z",
"endedAt": "2024-02-18T11:00:00.000Z",
"isAllDay": false,
"timeZone": "Asia/Tokyo",
"attendees": [
{
"userId": "cfmSbUHeizSoZob9cRA3N8fmfKg1",
"role": "admin",
"userType": 1
}
],
"location": "none",
"phoneNumber": null,
"access": null,
"address": null,
"customLocation": null,
"isRoutine": false,
"routine": null,
"isRemind": true,
"displayType": "teamPublic",
"visibilityType": "default",
"transparency": "opaque",
"priority": null,
"behavior": "event"
}Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
#/definitions/1384674required
Example
Not configured
Last modified: 3 months ago