renameSession

PATCH

/api/v1/sessions/{sessionId}

renameSession

curl --request PATCH \
  --url '<base-url>/api/v1/sessions/<sessionId>' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "title": "string"
}
'

const url = '<base-url>/api/v1/sessions/<sessionId>';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({title: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/sessions/<sessionId>"

payload = { "title": "string" }
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "id": "string",
  "agentId": "string",
  "origin": {
    "agentId": "string",
    "agentName": "string",
    "sessionId": "string"
  },
  "title": "string",
  "running": true,
  "createdBy": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

sessionId
string
required

Request body JSON required

title
string
required
maxLength: 200 · minLength: 1

Returns

200

Renamed.

JSON

id
string
required
agentId
string
required
title
string
required
running
boolean
required
createdBy
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
createdAt
string
required
format: date-time
updatedAt
string
required
format: date-time
origin
optional
object
Set when another agent started the session (send_message or ask).
- agentId
  string
  required
- agentName
  string
  required
- sessionId
  string
  required
  The other agent's session that sent the messages.
}

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required