Join a room via room code

Designing

Staging

https://staging.syncode.anggita.org/api

POST

/rooms/{roomId}/join

Rooms

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successfully joined the room

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://staging.syncode.anggita.org/api/rooms//join' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "roomCode": "string",
    "preferredRole": "host"
}'

Response Example

200 - Example 1

{
    "room": {
        "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
        "roomCode": "string",
        "name": "string",
        "status": "waiting",
        "mode": "peer",
        "hostId": "70e3fb2d-1cb6-4dbc-ab8d-fa7209aca5dd",
        "problemId": "ec266659-7df9-4c6c-913e-9aea62927d35",
        "language": "python",
        "config": {
            "maxParticipants": 2,
            "maxDuration": 0,
            "isPrivate": true
        },
        "participants": [
            {
                "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
                "username": "string",
                "displayName": "string",
                "avatarUrl": "string",
                "role": "host",
                "isActive": true,
                "joinedAt": "2019-08-24T14:15:22.123Z"
            }
        ],
        "myRole": "host",
        "myCapabilities": [
            "string"
        ],
        "currentPhaseStartedAt": "2019-08-24T14:15:22.123Z",
        "timerPaused": true,
        "elapsedMs": 0,
        "editorLocked": true,
        "createdAt": "2019-08-24T14:15:22.123Z"
    },
    "assignedRole": "host",
    "myCapabilities": [
        "string"
    ],
    "collabToken": "string",
    "collabUrl": "string"
}

Modified at 2026-03-11 21:12:01

Destroy a room (host only)

Leave a room