Invite Members - Aladia API

This endpoint invites a profile member to the Calendar specified by the Id, giving him a contextual role in this specific calendar

Expected path parameters:

calendarId: Calendar Id to which the member blongs.

Expected body data:

Json object with two arrays membersWithId and membersWIthEmail which are the invitees inside the platform and outside the platform.
for those outside the platform email is required but if the user is inside the platform profileId and the role it's being assigned as an array of objects. The role can be Owner, Organizer, Scheduler, and Participant.

Returns:

An object that tell the invitation is successfull.

curl --location --request POST 'https://api.aladia.io/v2/calendars/663a2c5effae959147ee2981/members/invite' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "ids": [ { "profileId": "66e19776c386d04f46720264", "role": "Scheduler" } ], "emails": [ { "email": "daniel.dereje@gmail.com" } ] }'

[ { "id": "679b5d6d15faad1650c53a23", "role": "calendar-participant", "calendarId": "679b5b49bff315b994c69775", "invited": true, "createdAt": "Thu Jan 30 2025 14:07:25 GMT+0300 (East Africa Time)", "updatedAt": "Thu Jan 30 2025 14:19:49 GMT+0300 (East Africa Time)", "email": "tamiratdereje167@gmail.com", "invitationStatus": "pending", "expiresAt": "2025-02-01T11:19:49.000Z" }, { "id": "679b5b5cbff315b994c6979d", "user": { "id": "679a7bffdedc0fbbcfdd0b16", "type": "profile" }, "role": "calendar-participant", "calendarId": "679b5b49bff315b994c69775", "invited": true, "createdAt": "Thu Jan 30 2025 13:58:36 GMT+0300 (East Africa Time)", "updatedAt": "Thu Jan 30 2025 14:19:49 GMT+0300 (East Africa Time)", "email": "temesgenzewude24@gmail.com", "invitationStatus": "pending", "expiresAt": "2025-02-01T11:19:49.000Z" }, { "id": "679b5b5cbff315b994c6979f", "user": { "id": "679a7de4dedc0fbbcfdd0eee", "type": "profile" }, "role": "calendar-participant", "calendarId": "679b5b49bff315b994c69775", "invited": true, "createdAt": "Thu Jan 30 2025 13:58:36 GMT+0300 (East Africa Time)", "updatedAt": "Thu Jan 30 2025 14:19:49 GMT+0300 (East Africa Time)", "email": "danielmisganaw192021@gmail.com", "invitationStatus": "pending", "expiresAt": "2025-02-01T11:19:49.000Z" }, { "id": "679b5b5cbff315b994c697a2", "user": { "id": "679a80edfab74d7760a15fe6", "type": "profile" }, "role": "calendar-participant", "calendarId": "679b5b49bff315b994c69775", "invited": true, "createdAt": "Thu Jan 30 2025 13:58:36 GMT+0300 (East Africa Time)", "updatedAt": "Thu Jan 30 2025 14:19:49 GMT+0300 (East Africa Time)", "email": "yohannesbekele107@gmail.com", "invitationStatus": "pending", "expiresAt": "2025-02-01T11:19:49.000Z" } ]

Request

Path Params

calendarId

string

required

The ID of the calendar where you want to add the member to.

Example:

663a2c5effae959147ee2981

Header Params

apikey

string

optional

Example:

Body Params application/json

ids

array [object {2}]

required

profileId

string

optional

role

string

optional

emails

array [object {1}]

required

string

optional

Examples

Responses

🟢201Created

application/json

Body

array of:

string

required

calendarId

string

required

calendar id

user

optional

profileId of the user you want to add to the calendar

Any of

owner

null

string | null

required

type

string | null

required

role

enum<string>

required

enum Owner,Owner,Scheduler, and Participant

Allowed values:

calendar-ownercalendar-organizercalendar-schedulercalendar-participant

invited

boolean | null

optional

createdAt

string

required

date

updatedAt

string

required

string | null

optional

invitationStatus

string | null

optional

expiresAt

string | null

optional

🟠403Forbidden

🟠401Unauthorized

🟠404Record Not Found