API Reference version 2

Invite user

POST/v2/room/{room_id_or_name}/invite/{user_id_or_email}

Invite a user to a public room. This API can only be called using a user token which can be obtained through:

  • Your own Personal API Token
  • Generating a token using one of the following grant_types:
    • authorization_code -- This is the authorization step of a 3-legged OAuth 2 flow
    • refresh_token -- When a 3-legged OAuth token expires, you can request a new one through this grant_type
    • password -- This grant_type allows you to request a user token by providing a username/password
Authentication required, with scope admin_room.
Accessible by users.

Path parameters

Type Parameter Description Required?
string user_id_or_email

The id, email address, or mention name (beginning with an '@') of the user to invite

Valid length range: 1 - 100.

Required
string room_id_or_name

The id or url encoded name of the room

Valid length range: 1 - 100.

Required

Request body

Type Property Description Required?
string reason

The reason to give to the invited user

Valid length range: 1 - 250.

204 No content