This document is generated by Aladia.

Invite Members

Testing

POST

/calendars/{calendarId}/events/{eventId}/members/invite

This endpoint invites a profile member to the Event specified by the Id, giving him a contextual role in this specific event.

Expected path parameters:

eventId: Event 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 host, guest, and co-host.

Returns:

An object that tell the invitation is successfull.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

201 - Success

{
    "id": "66fd105508a82fa0e5420041",
    "user": {
        "id": "66fbbb6f0a74b0dc6c8a33a0",
        "type": "profile"
    },
    "role": "co-host",
    "eventId": "66f636885550f70db3874945",
    "invited": true,
    "createdAt": "Wed Oct 02 2024 12:20:21 GMT+0300 (East Africa Time)",
    "updatedAt": "Wed Oct 02 2024 12:20:21 GMT+0300 (East Africa Time)",
    "email": "yohannesbekele107@gmail.com",
    "invitationStatus": "pending",
    "expiresAt": "2025-02-01T11:19:49.000Z"
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-04-09 13:01:43

Update Members

Remove a Member