Create an Event - Aladia API

The "create event" endpoint enables users to generate a new event on specific calendar by providing parameters such as name, calendar ID , and additional details.

The frequency object defines how often an event occurs. There are several types of frequencies, each with its own set of required fields.

1.Does-Not-Repeat Frequency

Type: "does-not-repeat"

Fields: None other than the type

Example:

{
  "frequency": {
    "type": "does-not-repeat"
  }
}

Daily, Weekly, or Monthly Frequency

Type: "daily", "weekly", or "monthly"

Fields: Only the type and endDate are required

Example:

{
  "frequency": {
    "type": "daily",
    "endDate": "2024-05-29T12:34:56+03:00"
  }
}

Custom Frequency

Type: "custom"

Periodicity: "day", "week", or "month"

Counter: Number of periods between occurrences

Fields for Weekly:

days: Array of days (0=Sunday, 1=Monday, ..., 6=Saturday)

Fields for Monthly:

monthlySelection: "specific-day-of-month" or "specific-weekday-of-month"

EndDate: Required

Examples:

Custom Daily

{
  "frequency": {
    "type": "custom",
    "periodicity": "day",
    "counter": 1,
    "endDate": "2024-05-29T12:34:56+03:00"
  }
}

Custom Weekly

{
  "frequency": {
    "type": "custom",
    "periodicity": "week",
    "counter": 1,
    "days": [3, 4, 5],
    "endDate": "2024-05-29T12:34:56+03:00"
  }
}

Custom Monthly (Specific Day of Month)

{
  "frequency": {
    "type": "custom",
    "periodicity": "month",
    "counter": 1,
    "monthlySelection": "specific-day-of-month",
    "endDate": "2024-05-29T12:34:56+03:00"
  }
}

Custom Monthly (Specific Weekday of Month)

{
  "frequency": {
    "type": "custom",
    "periodicity": "month",
    "counter": 1,
    "monthlySelection": "specific-weekday-of-month",
    "endDate": "2024-05-29T12:34:56+03:00"
  }
}

In summary:

Does-Not-Repeatonly needs the type field.

Daily, Weekly, Monthlytypes need the type and endDate fields.

Custom requires additional fields like periodicity, counter, and potentially days or monthlySelection, along with endDate.

curl --location --request POST 'https://api.aladia.io/v2/calendars//events' \ --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", "sharedCalendars": [ "668ce000b65a4607e140bb01", "668c0a0936fe1e5abb8601a9" ] }'

{ "id": "6683d08961cd35c5d029d657", "calendarId": "66819a7930cf852d849d3b1d", "name": "metafile", "description": null, "dates": { "startDate": "2024-05-24T09:34:56.000Z", "endDate": "2024-05-24T12:34:56.000Z" }, "frequency": { "type": "daily", "endDate": "2024-05-29T12:34:56+03:00" }, "onPremise": null, "onLive": { "roomId": "6688e5bd1ee4d1bb25a3d76a" }, "members": [ { "profileId": "6682554f41d2befed7040d7b", "role": "host", "picture": null, "fullName": "salasa salsa" } ], "createdAt": "2024-07-02T10:03:53.399Z", "updatedAt": "2024-07-02T10:03:53.399Z", "updatedBy": "6682554f41d2befed7040d7b", "parentId": null, "createdBy": "6682554f41d2befed7040d7b", "entityId": null, "entityType": null, "sharedCalendars": [], "attachments": [ { "metadata": { "name": "flower-lily", "mimetype": "image/jpeg", "size": 112984 }, "url": "https://storage.googleapis.com/76324282-3715-40d4-b113-8d8f07f8647e/6683d08661cd35c5d029d653?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bucket%40backend-test-aladia.iam.gserviceaccount.com%2F20240702%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240702T100354Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=50a2de25133716243a28119c0cb836b04bcbcfc310ca8c14bf03e58d3ec9fb7fb26abb4ebd5aa0c7f970ea92e91cd7357aed9e42cc8c5723743bd5b7808fdabf3cce56d670a79dbaab0d997f422204d0c1e707c97b33f7e02dc26c230003a417eda1e211cfe04d5423207e4b1bad516bb67c4122af08e23929783f0d499506ead38f171d9fcf6102a6571936993976eb18bf3e4cd0f9f8c006437ad15cbdb7dee85b401e09a5afbbde6a9d3f5bab66188f47c4458c8759589f971914f19920e63412085649ec673562bbc5bb5cff6871d48cbd506185715b826f018b1a60169128a4fea0a437169e790de0bd063281b68be26c9c95c1573688988cd118fc6dc9" } ] }

Request

Path Params

calendarId

string

required

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

required

name of the 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

sharedCalendars

array[string] | null

optional

shared calendar

guests

array[string] | null

optional

coHosts

array[string] | null

optional

roomStatus

string

required

live,closed,pending

guestNumber

number

optional

coHostNumber

number

optional

courseTeacherNumber

number

optional

courseAttendantNumber

number

optional

courseObserverNumber

number

optional

members

object

optional

ids

array [object {2}]

required

emails

array [object {2}]

optional

Examples

Responses

🟢201Created

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

🟠403Forbidden

🟠401Unauthorized

🟠404Record Not Found