Sign in
Sessions

Update Session

patch/session/{id}

Path parameters

idstring uuid required

The unique identifier for the resource.

Request body

namestring

This is the new name for the session. Maximum length is 40 characters.

status'active' | 'completed'

This is the new status for the session.

expirationSecondsnumber

Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.

Example request

{
  "expirationSeconds": 86400
}

Response

idstring required

This is the unique identifier for the session.

orgIdstring required

This is the unique identifier for the organization that owns this session.

createdAtstring date-time required

This is the ISO 8601 timestamp indicating when the session was created.

updatedAtstring date-time required

This is the ISO 8601 timestamp indicating when the session was last updated.

costnumber

This is the cost of the session in USD.

namestring

This is a user-defined name for the session. Maximum length is 40 characters.

status'active' | 'completed'

This is the current status of the session. Can be either 'active' or 'completed'.

expirationSecondsnumber

Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.

assistantIdstring

This is the ID of the assistant associated with this session. Use this when referencing an existing assistant.

squadIdstring

This is the squad ID associated with this session. Use this when referencing an existing squad.

customerIdstring

This is the customerId of the customer associated with this session.

phoneNumberIdstring

This is the ID of the phone number associated with this session.

Changes