Jicoo Developer Potal
  1. API Reference
  2. Schedule
Jicoo Developer Potal
  • Create powerful apps with Jicoo's API
  • Quick start
  • Authentication
  • Errors
  • Versioning
  • Types
  • API Reference Overview
  • Guide
    • How to use webhook
    • How to use Account integration
  • Guide(Japanese)
    • アカウント連携の使い方
    • Webhookの使い方
    • ホストの優先度を更新する方法
  • API Reference
    • Jicoo API
    • Webhook Schema
      • Webhook schema
      • event property
      • createdAt property
      • object property
      • contact property
      • answers property
      • answers items property
      • tracking property
    • Booking
      • List Bookings
      • Get Booking
      • Cancel Booking
      • Reschedule Booking
      • Create Booking
      • Update Booking
      • Get Booking Contacts
    • Schedule
      • Update Schedule
        PATCH
      • Create Schedule
        POST
      • List Schedules
        GET
      • Delete Schedule
        DELETE
    • Availability
      • List User Availability Calendars
      • Get User Availability Calendar
    • Oraganization
      • User
        • List Organization Users
        • Delete Organization User
        • Get Organization User
        • Update Organization User
      • Invitation
        • Create Organiztion Invitation
        • List Organization Invitations
        • Get Organization Invitation
        • Delete Organiztion Invitation
      • Get Organization Team
    • Event Types
      • Get Event Type
      • List Event Types
      • List Event Type Hosts
      • Get Event Type Available Schedules
      • Account Integration
      • Update Event Type Host
      • Delete Event Type Host
      • Create Event Type Host
  1. API Reference
  2. Schedule

Create Schedule

POST
/v1/schedules
スケジュール作成APIはユーザーが手動で新しいスケジュールをJicooカレンダーに追加することができます。このAPIはJicooインターフェイスを通して直接管理されるスケジュールを作成する為のもので、イベントタイプのページで行われた予約とは関係ありません。一度作成されたスケジュールはJicooカレンダーページに表示されます。

Request

Authorization
Add parameter in header
X-Jicoo-Api-Key
Example:
X-Jicoo-Api-Key: ********************
Body Params application/json
name
string 
required
<= 64 characters
description
optional
Any of
<= 10000 characters
routine
optional
Any of
duration
integer 
required
> 0
endedAt
required
schedules
array [object {7}] 
required
isRemind
boolean 
optional
projectId
number 
optional
> 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}] 
required
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 
required
startedAt
required
Any of
endedAt
required
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
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

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/schedules' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw '{
    "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"
        }
    ]
}'

Responses

🟢201Created
application/json
Body
data
object (Schedule) 
required
uid
string 
required
Unique ID of the schedule
name
string 
required
Name of the schedule
<= 64 characters
description
required
Description of the schedule
routine
required
Routine of the schedule
isRemind
boolean 
required
Reminder setting for the schedule
projectId
required
Project ID related to the schedule
phoneNumber
required
Phone number related to the schedule
access
required
Access information for the schedule
address
required
Address for the schedule
customLocation
required
Custom location for the schedule
attendees
array [object {4}] 
required
isAllDay
boolean 
required
If the schedule is for all day
timeZone
string 
required
Time zone of the schedule
startedAt
required
Start time of the schedule
endedAt
required
End time of the schedule
priority
required
Priority of the schedule
displayType
enum<string> 
required
Display type of the schedule
Allowed values:
privateteamPublicpublic
location
required
Location type of the schedule
transparency
enum<string> 
required
Transparency of the schedule
Allowed values:
opaquetransparent
behavior
enum<string> 
required
Behavior of the schedule
Allowed values:
eventwork
visibilityType
enum<string> 
required
Visibility type of the schedule
Allowed values:
defaultbusy
status
enum<string> 
required
Status of the schedule
Allowed values:
opencancel
url
string  | null 
required
URL related to the schedule
updatedAt
string <date-time>
required
Last update time of the schedule
createdAt
string <date-time>
required
Creation time of the schedule
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 2024-08-28 09:41:56
Previous
Update Schedule
Next
List Schedules
Built with