Skip to main content
PATCH
/
v1
/
voice-agents
/
collections
/
{id}
Update Collection.
curl --request PATCH \
  --url https://api.tryhamsa.com/v1/voice-agents/collections/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Collection Name",
  "description": "Updated description"
}
'
{
  "success": true,
  "message": "Collection updated successfully",
  "data": {
    "id": "d949f13f-40d2-4e48-ac86-b66633070603",
    "name": "Customer Support Tools",
    "description": "Tools used for customer support operations",
    "userId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "projectId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "webToolsCount": 5,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Path Parameters

​
id
string<uuid>
required

UUID of the collection to update.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

Body

application/json
​
name
string
required

Updated name of the collection (optional).

Example:

"Updated Collection Name"

​
description
string

Updated description of the collection (optional).

Example:

"Updated description"

Response

Successful response

​
success
boolean
Example:

true

​
message
string
Example:

"Collection updated successfully"

​
data
object