Jicoo Developer Potal
  1. Booking
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
      • Get Booking
        GET
      • Cancel Booking
        POST
      • Reschedule Booking
        POST
      • Create Booking
        POST
      • Update Booking
        PATCH
      • Get Booking Contacts
        GET
    • Schedule
      • Update Schedule
      • Create Schedule
      • List Schedules
      • Delete Schedule
    • 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. Booking

Create Booking

POST
/v1/bookings
The Create Booking API allows users to make a new booking. By submitting necessary details such as service selection, contact information, and preferred time slots, this API will create a new booking in the system. Upon successful creation, the API returns the booking details and a unique identifier for future reference.

Request

Authorization
Add parameter in header
X-Jicoo-Api-Key
Example:
X-Jicoo-Api-Key: ********************
Body Params application/json
startedAt
string <date-time>
required
timeZone
string 
required
eventTypeId
string 
required
email
string <email>
required
<= 255 characters
name
string 
required
<= 64 characters
company
string 
optional
<= 32 characters
textRemindCountryCode
string 
optional
<= 255 characters
textRemindNumber
string 
optional
<= 32 characters
ccEmails
array[string]
optional
<= 30 items
message
string 
optional
<= 2000 characters
locale
enum<string> 
optional
Allowed values:
jaen
locationId
required
Any of
Allowed values:
inPersonphonezoomgoogleMeetaskInviteeteamscustom
phoneNumber
string 
optional
<= 32 characters
tracking
object 
optional
campaign
string 
optional
<= 255 characters
source
string 
optional
<= 255 characters
medium
string 
optional
<= 255 characters
content
string 
optional
<= 255 characters
term
string 
optional
<= 255 characters
answers
array [object {2}] 
optional
questionUid
string 
required
content
required
payment
object 
optional
paymentMethod
enum<string> 
required
Allowed values:
nonecardonsite
items
array [object {1}] 
required
successUrl
string <uri>
optional
cancelUrl
string <uri>
optional
Example
{
  "eventTypeId": "mzgdPJVBb7RE",
  "timeZone": "Asia/Tokyo",
  "startedAt": "2024-03-16T02:00:00.000Z",
  "email": "guest@example.com",
  "name": "john doe",
  "location": null
}

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/bookings' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw '{
    "eventTypeId": "mzgdPJVBb7RE",
    "timeZone": "Asia/Tokyo",
    "startedAt": "2024-03-16T02:00:00.000Z",
    "email": "guest@example.com",
    "name": "john doe",
    "location": null
}'

Responses

🟢201Created
application/json
Body
data
required
Any of
uid
string 
required
Unique identifier for this booking
eventTypeId
string  | null 
required
EventTypeId associated with this event
name
string 
required
Booking name
description
string  | null 
required
Booking description
status
enum<string> 
required
Booking status
Allowed values:
requestopencancel
startedAt
string <date-time>
required
The time that event was scheduled to start in UTC time (e.g. "2024-03-01T20:00:00.000Z").
endedAt
string <date-time>
required
The time that event was scheduled to end in UTC time (e.g. "2024-03-01T21:00:00.000Z").
locationId
required
Location type. like zoom, google meet, etc.
url
string  | null 
required
online meeting url
phoneNumber
string  | null 
required
phone number
address
string  | null 
required
location address
customLocation
string  | null 
required
custom location name
access
string  | null 
required
access information
timeZone
string 
required
guest selected Timezone
priority
required
Booking priority
cancelReason
string  | null 
required
Booking cancel reason
cancelledAt
required
Booking cancelled time
cancelledBy
required
Booking canceller
hosts
array [object {2}] 
required
createdAt
string <date-time>
required
The time this booking was created
updatedAt
string <date-time>
required
The time this booking was updated
Examples
{
  "eventTypeId": null,
  "uid": "dolor id nostrud Excepteur dolore",
  "name": "nostrum neque nostrum",
  "description": "Facere non eveniet illo veritatis doloribus id quos omnis nemo. Facilis quis assumenda sunt. Unde iusto porro placeat. Itaque amet aut voluptas facilis rerum illo error.",
  "status": "open",
  "startedAt": "1989-06-01T18:37:12.594Z",
  "endedAt": "1984-11-20T03:14:06.112Z",
  "locationId": "phone",
  "url": "https://acrobatic-son.org",
  "phoneNumber": "(648) 998-7709 x67849",
  "address": null,
  "customLocation": "eiusmod",
  "access": null,
  "timeZone": "Atlantic/Azores",
  "priority": "high",
  "cancelReason": "veniam fugiat quis elit",
  "cancelledAt": null,
  "cancelledBy": null,
  "capacity": null,
  "hosts": [
    {
      "userId": "non",
      "role": "editor"
    }
  ],
  "createdAt": "2024-03-04T07:26:55.198Z",
  "updatedAt": "2024-03-04T05:10:21.686Z"
}
🟠409Conflict
Previous
Reschedule Booking
Next
Update Booking
Built with