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

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

uid

string

required

Body Params application/json

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/v1/schedules/' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw '{"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"}'

Responses

🟢200Success

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

{
  "data": {
    "uid": "string",
    "name": "string",
    "description": "string",
    "routine": {
      "duration": 1,
      "endedAt": "2019-08-24T14:15:22Z",
      "schedules": [
        {
          "id": 1,
          "hour": 0,
          "minute": 0,
          "wday": 0,
          "day": 1,
          "monthInterval": 0,
          "wdayInterval": 0,
          "dayInterval": 0
        }
      ]
    },
    "isRemind": true,
    "projectId": 1,
    "phoneNumber": "string",
    "access": "string",
    "address": "string",
    "customLocation": "string",
    "attendees": [
      {
        "userId": "string",
        "email": "user@example.com",
        "role": "admin",
        "userType": "host"
      }
    ],
    "isAllDay": true,
    "timeZone": "string",
    "startedAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "priority": "low",
    "displayType": "private",
    "location": "inPerson",
    "transparency": "opaque",
    "behavior": "event",
    "visibilityType": "default",
    "status": "open",
    "url": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

Modified at 2024-08-28 09:41:30

Get Booking Contacts

Create Schedule