This document is generated by Aladia.

Update an Event

Testing

PUT

/calendars/{calendarId}/events/{id}

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

Request Example

Shell

JavaScript

Java

Swift

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"
}'

Response Example

200 - Success

{
    "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

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-04-08 10:11:05

Create an Event

Delete an Event