Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Path Parameters

session_id
string
required

ID of the session to rename.

Body

application/json
name
string
required

New name for the session. Leading and trailing whitespace is removed before the 1-256 character limit is applied, so a whitespace-only value is rejected.

Required string length: 1 - 256
Example:

"Acme Corp research"

Response

The renamed session.

session
object

Full session object; see Retrieve session for every field.

queue_position
integer | null
Example:

null