For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Session›Update session name and status. (Server 2)
TestMu AI
StatusCommunityBlog
Selenium Automation API
Automated Screenshots API
App Automation API (Real Devices)
Smart UI
Cypress Automation
User Management
Test Manager
HyperExecute
Accessibility Testing
Analytics
Performance Testing
Audit logs
Session

Update session name and status. (Server 2)

To update the test session name and status {"passed","failed"}.

PATCH
/sessions/{session_id}
Update session name and status. (Server 2)
curl --request PATCH \
  --url "https://manual-api.lambdatest.com/sessions/{session_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "<name>",
    "status_ind": "<status_ind>",
    "custom_data": "<custom_data>"
  }'
{
  "message": "Session updated successfully",
  "status": "success"
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

session_idstringrequired

Session ID

Body

application/json

You can update both name and status of a session in single request.

namestring
status_indstring
custom_dataobject

Response

application/json

successful operation.

messagestring
statusstring
Update session name and status. (Server 2)
curl --request PATCH \
  --url "https://manual-api.lambdatest.com/sessions/{session_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "<name>",
    "status_ind": "<status_ind>",
    "custom_data": "<custom_data>"
  }'
{
  "message": "Session updated successfully",
  "status": "success"
}