dots.v2.agents.sessions.bySession_id().patch()
Generated on 5 Nov 2026
from DoTs version
v1.23.0
Usage
client.v2.agents.sessions.bySession_id(session_id).patch(body: Patch_session_request, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Get_session_response>Description
Partial update of session-scoped settings (not the agent manifest / config). The body must include at least one recognized patchable property; an empty object {} is 400. Only properties listed on PatchSessionRequest are accepted, any other top-level JSON key is rejected with 400. Omitted properties are left unchanged. Today the only patchable field is resume_on_topoff; more session settings may be added over time. Terminal sessions (DESTROYED, FAILED) cannot be patched.
Parameters
Path Parameters
session_idstring requiredExample:
a1b2c3d4-e5f6-7890-abcd-ef1234567890The session UUID.
Request Body
resumeOnTopoffboolean optionalExample:
falseWhen present, sets whether this session opts in to automatic resumption when the team's prepayment balance is restored after a low-balance pause. Session-scoped consent, not config-scoped. Omitted properties are not modified.
Request Sample
Response Example
More Information
See /v2/agents/sessions/{session_id} in the API reference for additional detail on responses, headers, parameters, and more.