Update Schedule
/v1/schedules/{uid}
Request
Path Params
uid
string
required
Body Params application/json
name
string
optional
<= 64 characters
description
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
<= 10000 characters
null
optional
routine
anyOf {2}
anyOf, must be valid against any of the subschemas
object {3}
optional
null
optional
isRemind
boolean
optional
projectId
anyOf {2}
anyOf, must be valid against any of the subschemas
number
optional
> 0
null
optional
phoneNumber
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
<= 32 characters
null
optional
access
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
<= 2000 characters
null
optional
address
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
<= 255 characters
null
optional
customLocation
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
<= 2000 characters
null
optional
attendees
array [object {4}]
optional
userId
string
optional
email
string <email>
optional
role
string
required
Allowed values:
admineditorviewer
userType
string
required
Allowed values:
hostguest
isAllDay
boolean
optional
timeZone
string
optional
startedAt
anyOf {2}
anyOf, must be valid against any of the subschemas
string <date-time>
optional
null
optional
endedAt
anyOf {2}
anyOf, must be valid against any of the subschemas
string <date-time>
optional
null
optional
priority
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
Allowed values:
lowmiddlehigh
null
optional
displayType
string
optional
Allowed values:
privateteamPublicpublic
location
anyOf {2}
anyOf, must be valid against any of the subschemas
string
optional
Allowed values:
inPersonphonezoomgoogleMeetaskInviteeteamscustom
null
optional
transparency
string
optional
Allowed values:
opaquetransparent
behavior
string
optional
Allowed values:
eventwork
visibilityType
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 : JSON
Data Schema
data
#/definitions/1384674required
Example
Not configured
Modified at 2 months ago