This document is generated by Aladia.

Invite Members

Testing

POST

/calendars/{calendarId}/members/invite

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.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠403Forbidden

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aladia.io/v2/calendars/69c670381073b59cac7e3dc7/members/invite' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data '{"ids":[{"profileId":"6989c9b259779a2fe65389ce","role":"calendar-participant"},{"profileId":"698595bd25853a0a89b83c81","role":"calendar-participant"}],"emails":[]}'

Response Example

201 - Success

[
    {
        "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"
    }
]

Modified at 2026-03-27 12:09:19

Update Members

Accept an Invitation