Get or Create a Client Session
Returns a client session with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
Returns a client session with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
Code
await seam.clientSessions.getOrCreate({
user_identifier_key: "jane_doe",
connect_webview_ids: ["5e297cfe-23df-4638-bb87-08c4f0f8233b"],
connected_account_ids: ["f87f0ab7-b8d7-44aa-9e59-3239b209570e"],
user_identity_id: "71ff7f71-2cf4-458a-8db4-6ad539c8b66a",
expires_at: "2025-06-18T06:10:42.000Z",
});
Output
{
"client_session_id": "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
"connect_webview_ids": ["5e297cfe-23df-4638-bb87-08c4f0f8233b"],
"connected_account_ids": ["f87f0ab7-b8d7-44aa-9e59-3239b209570e"],
"created_at": "2025-06-15T16:54:17.946309Z",
"customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
"device_count": 1,
"expires_at": "2025-06-18T06:10:42.000Z",
"token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
"user_identifier_key": "jane_doe",
"user_identity_id": "71ff7f71-2cf4-458a-8db4-6ad539c8b66a",
"workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
}
Request Parameters
connect_webview_ids
Array of Strings
IDs of the Connect Webviews that you want to associate with the client session (or that are already associated with the existing client session).
connected_account_ids
Array of Strings
IDs of the connected accounts that you want to associate with the client session (or that are already associated with the existing client session).
expires_at
String
Date and time at which the client session should expire (or at which the existing client session expires), in ISO 8601 format.
user_identifier_key
String
Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
user_identity_id
String
ID of the user identity that you want to associate with the client session (or that are already associated with the existing client session).
user_identity_ids
Array of Strings
IDs of the user identities that you want to associate with the client session.
Response
{
"client_session_id": "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
"connect_webview_ids": ["550e8400-e29b-41d4-a716-446655440000"],
"connected_account_ids": ["f47ac10b-58cc-4372-a567-0e02b2c3d479"],
"created_at": "2025-06-15T16:54:17.946309Z",
"customer_id": "77eccc4e-c8bc-4c7d-b83c-cb853ed3bade",
"device_count": 1,
"expires_at": "2025-06-17T16:54:17.946309Z",
"token": "seam_cst1891oqCmB_6dBwV8PJ2Fsoe9dWYVyMfVHq",
"user_identifier_key": "user_id_1",
"user_identity_id": "a6e93f84-565e-47d7-8908-1ca71ada373c",
"user_identity_ids": ["a6e93f84-565e-47d7-8908-1ca71ada373c"],
"workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
}
Last updated
Was this helpful?