Skip to main content
PUT
Set Session Peers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id
string
required
session_id
string
required

Body

application/json

List of peer IDs (with session-level configuration) to set for the session

{key}
SessionPeerConfigInput · object

A session-peer configuration as a request sends it.

Adds joined_at, which is write-only: it is a property of the membership row, not of the configuration, so SessionPeerConfig (what is stored and returned) does not have it.

Response

Successful Response

id
string
required
uid
string
required

Immutable identifier Honcho assigns to this session. id is the name the client chose; uid is generated by the server.

is_active
boolean
required
workspace_id
string
required
created_at
string<date-time>
required
metadata
Metadata · object
configuration
Configuration · object
scopes
string[] | null

Names of the scopes this session is an active member of. Only returned by the session list when include_scopes is true.