Create Schedule
/v1/schedules
Request
Body Params application/json
name
string
required
<= 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
number
optional
> 0
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}]
required
userId
string
optional
email
string <email>
optional
role
string
required
Allowed values:
admineditorviewer
userType
string
required
Allowed values:
hostguest
isAllDay
boolean
optional
timeZone
string
required
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
Example
{
"name": "MTG",
"timeZone": "Asia/Tokyo",
"startedAt": "2024-04-01T14:00:00.000Z",
"endedAt": "2024-04-01T14:30:00.000Z",
"routine": null,
"attendees": [
{
"userId": "cfmSbUHeizSoZob9cRA3N8fmfKg1",
"role": "admin",
"userType": "host"
}
]
}
Request samples
Responses
Created(201)
HTTP Code: 201
Content Type : JSON
Data Schema
data
#/definitions/1384674required
Example
{
"name": "dignissimos voluptas iusto",
"startedAt": "2024-03-01T14:00:00.000Z",
"endedAt": "2024-03-01T14:30:00.000Z",
"address": "ut fugiat",
"phoneNumber": "561-428-5385 x054",
"customLocation": "huddle",
"description": "Sequi earum minus dicta. Asperiores maxime illo rem voluptates a nemo beatae. Odio quia quisquam necessitatibus dolore.",
"routine": null,
"isRemind": true,
"access": "qui",
"attendees": [
{
"userId": "cfmSbUHeizSoZob9cRA3N8fmfKg1",
"role": "admin",
"userType": "host"
}
],
"isAllDay": false,
"timeZone": "Asia/Tokyo",
"priority": "middle",
"displayType": "teamPublic",
"location": "zoom",
"transparency": "transparent",
"behavior": "work",
"visibilityType": "default"
}
Modified at 2 months ago