---
url: /apidocs/social_invitation.md
---
## Invitations API

| Endpoint | Method | Description |
|-----|-----|-----|
| [social:inviteUsers](#invite-users-to-room) | websocket | Invite users to room |
| [social:deleteInvitation](#delete-invitation) | websocket | Delete invitation |
| [social:editInvitation](#edit-invitation) | websocket | Edit invitation |
| [social:acceptInvitation](#accept-invitation) | websocket | Accept invitation |
| ~~[social:archiveInvitation](#archive-invitation)~~ | websocket | Archive invitation |
| ~~[social:unarchiveInvitation](#unarchive-invitation)~~ | websocket | Unarchive invitation |
| [room:getRoomInvitations](#get-room-invitations) | websocket | Get room invitations |
| [room:getUserRoomAccessInfo](#get-user-room-access-info) | websocket | Get user room access info |
| [social:getUserInvitations](#get-user-invitations) | websocket | Get user invitations |
| ~~[social:getArchivedInvitations](#get-archived-user-invitations)~~ | websocket | Get archived user invitations |
| [social:requestThoughtsOfUsers](#request-thoughts-of-users) | websocket | Request thoughts of users |
| [social:onInvitationCreated](#on-invitation-created-event) | websocketEvent | On invitation created event |
| [social:onInvitationEdited](#on-invitation-edited-event) | websocketEvent | On invitation edited event |
| [social:onInvitationDeleted](#on-invitation-deleted-event) | websocketEvent | On invitation deleted event |
| [room:permissionsChanged](#on-user-room-permissions-changed-event) | websocketEvent | On user room permissions changed event |

### Invite users to room

**Method:** websocket

**Endpoint:** social:inviteUsers

**Description:** Invite multiple users to the room.

Function creates user request of "Invitation" type. See [requests API](request.md) for further steps.

**Request:**

**Response:**

### Delete invitation

**Method:** websocket

**Endpoint:** social:deleteInvitation

**Request:**

**Response:**

### Edit invitation

**Method:** websocket

**Endpoint:** social:editInvitation

**Description:** Function creates user request of "Invitation" type, if owner permission granted. See [requests API](request.md) for further steps.

**Request:**

**Response:**

### Accept invitation

**Method:** websocket

**Endpoint:** social:acceptInvitation

**Request:**

**Response:**

### Archive invitation

**Method:** websocket

**Endpoint:** social:archiveInvitation

**DEPRECATED**

**Description:** Endpoint is deprecated, not used and is going to be removed.

**Request:**

**Response:**

### Unarchive invitation

**Method:** websocket

**Endpoint:** social:unarchiveInvitation

**DEPRECATED**

**Description:** Endpoint is deprecated, not used and is going to be removed.

**Request:**

**Response:**

### Get room invitations

**Method:** websocket

**Endpoint:** room:getRoomInvitations

**Request:**

**Response:**

### Get user room access info

**Method:** websocket

**Endpoint:** room:getUserRoomAccessInfo

**Description:** Returns whether the target user has access to the room (via an explicit invitation, or implicitly, e.g. the room is public) along with that invitation, if one exists. The calling user must have view access to the room.

**Request:**

**Response:**

### Get user invitations

**Method:** websocket

**Endpoint:** social:getUserInvitations

**Request:**

**Response:**

### Get archived user invitations

**Method:** websocket

**Endpoint:** social:getArchivedInvitations

**DEPRECATED**

**Description:** Endpoint is deprecated, not used and is going to be removed.

**Request:**

**Response:**

### Request thoughts of users

**Method:** websocket

**Endpoint:** social:requestThoughtsOfUsers

**Description:** Function works the same way as user invitation. Additionally, function creates request though notification and email.

**Request:**

**Response:**

### On invitation created event

**Event:** social:onInvitationCreated

**Data:**

### On invitation edited event

**Event:** social:onInvitationEdited

**Data:**

### On invitation deleted event

**Event:** social:onInvitationDeleted

**Data:**

### On user room permissions changed event

**Event:** room:permissionsChanged

**Data:**

## Models

#### Invitation Info

#### User Simple

#### Room

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action

#### Room Style

#### Room Panel

#### Geometry

#### XYZ

#### Room Prop

#### Storyline

#### Camera Position

#### XYZW