Skip to main content
Session›Update test session details.
TestMu AI
StatusCommunityBlog
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 test session details.

To update the test session name, status {"passed","failed","skipped", "ignored", "unknown", "error"}, reason, test tags.

PATCH
/sessions/{session_id}
Update test session details.
curl --request PATCH \
  --url "https://api.lambdatest.com/automation/api/v1/sessions/{session_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "<name>",
    "status_ind": "<status_ind>",
    "reason": "<reason>",
    "custom_data": "<custom_data>",
    "tags": []
  }'
{
  "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 name, status, test tags of a session in single request.

namestring
status_indstring
reasonstring
custom_dataobject
tagsarray

Response

application/json

successful operation.

messagestring
statusstring
Update test session details.
curl --request PATCH \
  --url "https://api.lambdatest.com/automation/api/v1/sessions/{session_id}" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "<name>",
    "status_ind": "<status_ind>",
    "reason": "<reason>",
    "custom_data": "<custom_data>",
    "tags": []
  }'
{
  "message": "Session updated successfully",
  "status": "success"
}