Update a Calendar - Aladia API

The "Update Calendar" endpoint allows users to modify existing calendar entries. This includes updating details such as the calendar's name, schedule, and other relevant information.

Some of Request Data

name (required, string): The name of the calendar.

type (optional, string): The type of the calendar.

color (required, string): The color code representing the calendar.

eventDuration (optional, number): The default duration of events in the calendar.

schedule (optional, object): A map representing the calendar's schedule settings, with each key being a day and the value being an array of time slots.

Other fields....

curl --location --request PUT 'https://api.aladia.io/v2/calendars/664486a14ba300aaed0b4c6d' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "new sala", "type": "public", "color": "indigo", "eventDuration": 60, "schedule": { "monday": [ { "startTime": "2024-04-22T09:34:44.728Z", "endTime": "2024-04-22T10:00:00.000Z" } ], "tuesday": [ { "startTime": "2024-04-23T08:34:44.728Z", "endTime": "2024-04-23T10:00:00.000Z" }, { "startTime": "2024-04-23T10:01:00.000Z", "endTime": "2024-04-23T12:08:36.331Z" } ], "wednesday": [ { "startTime": "2024-04-24T08:34:44.728Z", "endTime": "2024-04-24T10:30:00.000Z" } ], "thursday": [ { "startTime": "2024-05-09T09:30:00.000Z", "endTime": "2024-05-09T11:30:00.000Z" } ], "friday": [ { "startTime": "2024-05-10T09:30:00.000Z", "endTime": "2024-05-10T11:30:00.000Z" } ], "saturday": [ { "startTime": "2024-05-11T09:30:00.000Z", "endTime": "2024-05-11T11:30:00.000Z" } ], "sunday": [ { "startTime": "2024-05-12T10:30:00.000Z", "endTime": "2024-05-12T11:00:00.000Z" } ] }, "timezone": "GMT", "eventBaseDuration": 60, "isScheduleEnforced": false }'

{ "id": "magna dolor", "ownerId": "est cillum dolore", "parentId": "occaecat Lorem reprehenderit veniam", "title": "esse veritatis quas", "type": "public", "color": "fuchsia", "members": {}, "eventDuration": "pariatur elit commodo", "scheduleSettings": { "monday": [ { "startTime": "2024-04-24T05:19:22.994Z", "endTime": "2024-04-23T11:48:53.740Z" }, { "startTime": "2024-04-23T11:57:38.427Z", "endTime": "2024-04-24T00:57:36.473Z" }, { "startTime": "2024-04-23T13:08:19.337Z", "endTime": "2024-04-23T13:26:35.219Z" } ], "tuesday": [ { "startTime": "2024-04-23T20:37:22.297Z", "endTime": "2024-04-23T15:18:01.777Z" } ], "wednesday": [ { "startTime": "2024-04-23T20:36:04.291Z", "endTime": "2024-04-24T00:03:03.200Z" } ], "thursday": [ { "startTime": "2024-04-23T23:00:32.206Z", "endtime": "2024-04-23T23:10:54.003Z" }, { "startTime": "2024-04-24T00:49:52.453Z", "endtime": "2024-04-24T01:05:15.225Z" } ], "friday": [ { "startTime": "2024-04-24T07:05:59.955Z", "endTime": "2024-04-23T18:44:44.748Z" }, { "startTime": "2024-04-23T13:06:40.581Z", "endTime": "2024-04-24T04:16:42.577Z" }, { "startTime": "2024-04-23T18:17:52.039Z", "endTime": "2024-04-24T04:52:25.510Z" } ], "saturday": [ { "startTime": "2024-04-23T18:35:44.349Z", "endTime": "2024-04-24T04:14:58.514Z" }, { "startTime": "2024-04-23T19:23:10.184Z", "endTime": "2024-04-24T06:24:48.357Z" }, { "startTime": "2024-04-23T12:48:18.417Z", "endTime": "2024-04-23T16:06:59.164Z" } ], "sunday": [ { "startTime": "2024-04-23T23:07:54.897Z", "endTime": "2024-04-24T04:41:20.357Z" } ] }, "events": [ "Ut ullamco deserunt dolor" ], "createdAt": "2024-04-23T20:39:41.605Z", "updatedAt": "2024-04-23T11:41:55.134Z", "updatedBy": "aliquip dolor ipsum sunt minim", "isScheduleEnforced": false }

Request

Path Params

string

required

calendar id

Example:

664486a14ba300aaed0b4c6d

Header Params

apikey

string

optional

Example:

Body Params application/json

string

required

name

string

required

Name of the calendar

color

string

required

Color of the calendar

eventDuration

number | null

optional

Default duration for events in the calendar

schedule

object | null

optional

Schedule settings of the calendar

monday

array [object {2}]

optional

schedule time available

tuesday

array [object {2}]

optional

schedule time available

wednesday

array [object {2}]

optional

schedule time available

thursday

array [object {2}]

optional

schedule time available

friday

array [object {2}]

optional

schedule time available

saturday

array [object {2}]

optional

schedule time available

sunday

array [object {2}]

optional

schedule time available

updatedBy

string

required

The user who updated the calendar.

defaultCalendar

boolean | null

optional

true if it is created through singup otherwise it is false.

entityId

string | null

optional

Used to identify the type of calendar and required only for course calendars and will be set to the course ID. For personal and other organization-created calendars, entityId is not needed.

entityType

string | null

optional

It specifies the type of calendar being created. It can be set to course, lecture, or category, depending on the nature of the calendar.

owner

object | null

optional

string

optional

type

string

optional

timezone

string | null

optional

time zone of your calendar like UTC, GMT ...

eventBaseDuration

number | null

optional

base duration of the events going to be created for this calendar.

isScheduleEnforced

boolean | null

optional

Examples

Responses

🟢200Success

application/json

Body

string

required

name

string

required

Name of the calendar

color

string

required

Color of the calendar

eventDuration

number | null

optional

Default duration for events in the calendar

schedule

object | null

optional

Schedule settings of the calendar

monday

array [object {2}]

optional

schedule time available

tuesday

array [object {2}]

optional

schedule time available

wednesday

array [object {2}]

optional

schedule time available

thursday

array [object {2}]

optional

schedule time available

friday

array [object {2}]

optional

schedule time available

saturday

array [object {2}]

optional

schedule time available

sunday

array [object {2}]

optional

schedule time available

createdAt

string

required

The date calendar created.

updatedAt

string

required

Last time calendar updated.

updatedBy

string

required

The user who updated the calendar.

defaultCalendar

boolean | null

optional

true if it is created through singup otherwise it is false.

entityId

string | null

optional

Used to identify the type of calendar and required only for course calendars and will be set to the course ID. For personal and other organization-created calendars, entityId is not needed.

entityType

string | null

optional

It specifies the type of calendar being created. It can be set to course, lecture, or category, depending on the nature of the calendar.

owner

object | null

optional

string

optional

type

string

optional

timezone

string | null

optional

time zone of your calendar like UTC, GMT ...

eventBaseDuration

number | null

optional

base duration of the events going to be created for this calendar.

isScheduleEnforced

boolean | null

optional

🟠404Record Not Found

🟠403Forbidden

🟠401Unauthorized