Report Invite Token Usage

Prev Next
Post
/api/v1/useInviteToken

Report to the workspace that an invite token was used.

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "token": "iS7pza"
}
object
token
string Required

The invite ID being used.

Responses
200

OK

Success
{
  "room": {
    "rid": "QqsWiqNH2TnxtvZQq",
    "fname": "a-room-name",
    "name": "a-room-name",
    "t": "p"
  },
  "success": true
}
Expand All
object
room
object
rid
string
fname
string
name
string
t
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string