Join a Temporary Room as a guest

POST

/api/v1/external/rooms/{room_id}/guests

Creates a restricted guest user and one guest session token scoped to this Temporary Room.

Parameters

Path Parameters

room_id

required

string

The ID of the room.

Example

01kxb0t5c4ccf16vp1qt0y0mer

Request Body ^required

object

nickname

required

Guest display nickname.

string

Mei

client_id

Must be a valid UUID.

string

nullable

a4855dc5-0acb-33c3-b921-f4291f719ca0

preferred_language

required

Guest preferred language.

string

zh-CN

Responses

201

object

data

object

guest

object

id

string

01HX...

nickname

string

Mei

preferred_language

string

zh-CN

session

object

token

string

grst_...

token_type

string

guest

header

string

X-Rosetta-Guest-Token

expires_at

string

2026-06-12T12:00:00+00:00

room

object

room_id

string

01HX...

workspace_id

string

01HX...

channel_id

string

01HX...

name

string

Customer Support Room

status

string

active

expires_at

string

2026-06-12T12:00:00+00:00

{
  "data": {
    "guest": {
      "id": "01HX...",
      "nickname": "Mei",
      "preferred_language": "zh-CN"
    },
    "session": {
      "token": "grst_...",
      "token_type": "guest",
      "header": "X-Rosetta-Guest-Token",
      "expires_at": "2026-06-12T12:00:00+00:00"
    },
    "room": {
      "room_id": "01HX...",
      "workspace_id": "01HX...",
      "channel_id": "01HX...",
      "name": "Customer Support Room",
      "status": "active",
      "expires_at": "2026-06-12T12:00:00+00:00"
    }
  }
}

410

Expired room

object

message

string

Temporary Room is not available.

errors

object

code

Array<string>

[
  "temporary_room_expired"
]

{
  "message": "Temporary Room is not available.",
  "errors": {
    "code": [
      "temporary_room_expired"
    ]
  }
}