Update a session

Request

Update a session's key, custom properties, or associated recordings. All recordings must belong to the same device and project. Session keys must be unique within the project.

Security

ApiKey(Required scopes: sessions.update)

Path

keyOrIdstringrequired

Recording Session Key or ID

Query

projectIdstring

Filter sessions by project. Required for multi-project orgs.

Bodyapplication/jsonrequired

keystring or null, non-empty

A user-supplied identifier, unique within the project. Pass null to clear an existing key.

addRecordingIdsArray of strings

Recording display IDs to add to the session.

removeRecordingIdsArray of strings

Recording display IDs to remove from the session.

propertiesobject

A key-value map from session custom property keys to their values. Omitted keys are unchanged. Set a value to null to remove it.

Payload

{
  "key": "string",
  "addRecordingIds": [
    "string"
  ],
  "removeRecordingIds": [
    "string"
  ],
  "properties": {}
}

Responses

Updated session

Bodyapplication/json

idstringrequired

ID of the recording session

projectIdstringrequired

The project ID that the session belongs to

deviceobject(DeviceSummary)required

ID and name of a device.

keystring

A user-supplied identifier, unique within the project.

createdAtstring, (date-time)required

Timestamp when the session was created.

updatedAtstring, (date-time)required

Timestamp when the session was last updated.

propertiesobject(CustomPropertyValues)

A key-value map of the custom properties associated with this session.

recordingsArray of objectsrequired

Recordings associated with this session.

Response

{
  "id": "string",
  "projectId": "string",
  "device": {
    "id": "string",
    "name": "string"
  },
  "key": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  },
  "recordings": [
    { … }
  ]
}