Invite user to room

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Send an invitation to a user to join the room. User will receive a notification/email with an invite link. Only admins can invite.

Path Parameters

id number required

Unique numeric room ID

application/json

Request Body required

User identification for invitation (email or userId)

userIds string[] required

emails string[] required

Responses

Invitation sent successfully

application/json

Schema

Example (from schema)

Example

Schema

invited boolean required

inviteStatus object required

oneOf

{
  "invited": true,
  "inviteStatus": {
    "user-123": true,
    "user-456": "already_a_member"
  }
}

{
  "invited": true,
  "inviteStatus": {
    "user-123": true,
    "user-456": "already_a_member"
  }
}