Update an Event - Aladia API

The "update event" endpoint allows users to modify existing evnt entries, enabling them to make changes to names, dates, and other relevant details within an event.
in case of frequency we have to provide update type that have three choices that is "this" only update the current event, "casacde" the current and following event and "all" which update all event associated with this event

the above only works when the events are recurring events and have the same parent id

curl --location -g --request PUT 'https://api.aladia.io/v2/calendars/{{calendarId}}/events/{{eventId}}' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "one", "dates": { "startDate": "2024-07-08T10:45:00.000+03:00", "endDate": "2024-07-08T11:45:00.000+03:00" }, "description": "tell them", "frequency": { "type": "daily", "endDate": "2024-07-12T12:34:56+03:00" }, "discription": "this is the new event" }'

{ "id": "6644883a4ba300aaed0b4c86", "calendarId": "66423504c4ac20c33197ce10", "name": "updated Event", "description": "This is the new sample event description.", "attachments": [ "file1.pdf", "image.jpg" ], "dates": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-05T23:59:59.999Z" }, "frequency": { "type": "doesnotrepeat", "periodicity": "day", "counter": 1, "days": [ "Monday", "Friday" ], "endDate": "2024-10-25T23:00:00.999Z" }, "onPremise": { "onPremise": true, "address": "123 Main St, City, Country" }, "onLive": { "onLive": true, "roomId": "room123", "roomLink": "https://newexample.com/room123" }, "sharedCalendars": [ "6638f3820903801d1cdcf2a4", "6638f3820903801d1cdcf2a4" ], "members": {}, "createdAt": "2024-05-15T10:02:34.233Z", "updatedAt": "2024-05-15T10:06:49.006Z", "updatedBy": "6638f3820903801d1cdcf2a4", "parentId": null, "createdBy": "663a2c5effae959147ee2981" }

Request

Path Params

calendarId

string

required

Example:

string

required

Event Id

Example:

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

required

name of the event

description

string | null

optional

description of ther event

dates

object

required

event dates

startDate

string

required

start date

endDate

string

required

end date

frequency

object | null

optional

event repeat frequency

type

enum<string>

optional

Type of recurrency

Allowed values:

dailyweeklymonthlycustomdoes-not-repeat

periodicity

enum<string>

optional

Only for Costum, Repeat frequency

Allowed values:

dayweekmonth

counter

number

optional

Only for Costum, every how many days, weeks, months repeat the event

days

array[number]

optional

Only for Costum, with periodicity=weekly Repeat days

endDate

string

optional

Only for Costum, define when frequency end

entity

object | null

optional

string

optional

type

string

optional

guestNumber

number

optional

coHostNumber

number

optional

courseTeacherNumber

number

optional

courseAttendantNumber

number

optional

courseObserverNumber

number

optional

members

object

optional

Old members after removing the others you want to remove. Remember this exclude the newly added members

ids

array [object {2}]

required

emails

array [object {2}]

optional

removedMembers

object

optional

Removed members from current event.

ids

array [object {2}]

required

emails

array [object {2}]

optional

addedMembers

object

optional

This represent newly added members

ids

array [object {2}]

required

emails

array [object {2}]

optional

Examples

Responses

🟢200Success

application/json

Body

string

required

calendarId

string

required

calendar of the event

name

string

required

name of the event

description

string | null

optional

description of ther event

attachments

array[string]

optional

event attachments

dates

object

required

event dates

startDate

string

required

start date

endDate

string

required

end date

frequency

object | null

optional

event repeat frequency

type

enum<string> | enum<null>

optional

Type of recurrency

Allowed values:

dailyweeklymonthlycustomdoes-not-repeat

periodicity

enum<string> | enum<null>

optional

Only for Costum, Repeat frequency

Allowed values:

dayweekmonth

counter

number | null

optional

Only for Costum, every how many days, weeks, months repeat the event

days

array[number] | null

optional

Only for Costum, with periodicity=weekly Repeat days

endDate

string | null

optional

Only for Costum, define when frequency end

onPremise

object | null

optional

Place adress for attending the lesson

address

string | null

optional

Adress for attending the event

live

object | null

optional

Link meeting

roomId

string | null

optional

Id of the room of 100ms

parentId

string | null

optional

Event which from the frequency start

entity

object | null

optional

string

optional

type

string

optional

sharedCalendars

array[string] | null

optional

shared calendar

createdAt

string

required

date

updateEventTarget

string | null

optional

enum this, cascade, all

calendarsUpdateStrategy

string | null

optional

enum this,all

resetFields

string

optional

feilds that will not be shared to other calendar

updatedAt

string

required

date

updatedBy

string

optional

User who update the event

createdBy

string

required

User who crated the event

owner

object | null

optional

string

optional

type

string

optional

roomStatus

string

required

live,closed,pending

lectureId

string | null

optional

guestNumber

number

optional

coHostNumber

number

optional

courseTeacherNumber

number

optional

courseAttendantNumber

number

optional

courseObserverNumber

number

optional

endDateReference

object | null

optional

guestMembers

array[object (member.rto) {10}] | null

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string | null

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string | null

optional

coHostMembers

array[object (member.rto) {10}] | null

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string | null

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string | null

optional

courseTeacherMembers

array[object (member.rto) {10}] | null

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string | null

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string | null

optional

courseAttendantMembers

array[object (member.rto) {10}] | null

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string | null

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string | null

optional

courseObserverMembers

array[object (member.rto) {10}] | null

optional

string

optional

The start date for the usage range [ISODate]

fullName

string

optional

The end date for the usage range [ISODate]

picture

string | null

optional

Usage results as array of measurements

role

string

optional

group

string

optional

online

boolean

optional

invited

boolean

optional

invitedAt

string

optional

lastActivity

string

optional

invitationStatus

string | null

optional

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found